Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Links in README.md before making a release #3035

Closed
msetina opened this issue Feb 18, 2024 · 2 comments · Fixed by #3052
Closed

Update Links in README.md before making a release #3035

msetina opened this issue Feb 18, 2024 · 2 comments · Fixed by #3052
Projects
OpenSC 0.25.0

Comments

@msetina
Copy link
Contributor

msetina commented Feb 18, 2024

README file contains:
Do NOT use any links from wiki to download the OpenSC because wiki can be modified by anybody, see
#2554. For downloading OpenSC, use the links here in README.

Downloads

OpenSC 0.23.0 is the latest stable version released on
29.11.2022. It is available as
@msetina msetina changed the title opensc-0.24.0.tar.gz has README containg 0.23 info opensc-0.24.0.tar.gz has README containing 0.23 info Feb 18, 2024
@frankmorgner
Copy link
Member

We will not change the 0.24.0 artifacts anymore, but with your comment in mind, we'll try to make sure that 0.25.0 files contain the correct links

@frankmorgner frankmorgner added this to In progress in OpenSC 0.25.0 Feb 18, 2024
@frankmorgner frankmorgner changed the title opensc-0.24.0.tar.gz has README containing 0.23 info Update Links in README.md before making a release Feb 18, 2024
@Jakuje
Copy link
Member

Jakuje commented Feb 19, 2024

Thank you for the suggestion! I did it after the release last time as files exist only after we tag the release, the artifacts are built and uploaded to the release page itself. The paths are fixed so it can be certainly done before the release. But I wanted to avoid to have a dead links on the main page of the project before all the stuff will be ready.
Other option might be going back to the wiki given that we did not open it for modification of non-members (and I do not think we will do it any time soon).

frankmorgner added a commit to frankmorgner/OpenSC that referenced this issue Feb 27, 2024
@frankmorgner
doc: generalize README.md
4cf25a2 
Note the use of http:https://htmlpreview.github.io for rendering HTML pages from Github.
From now on, no more modification to README.md should be needed on releases, as we use the Github sticky link
https://github.com/OpenSC/OpenSC/releases/latest

fixes OpenSC#3035
@frankmorgner frankmorgner mentioned this issue Feb 27, 2024
Merged
5 tasks
frankmorgner added a commit to frankmorgner/OpenSC that referenced this issue Mar 1, 2024
@frankmorgner
doc: generalize README.md
eb6f29b 
Note the use of http:https://htmlpreview.github.io for rendering HTML pages from Github.
From now on, no more modification to README.md should be needed on releases, as we use the Github sticky link
https://github.com/OpenSC/OpenSC/releases/latest

fixes OpenSC#3035
frankmorgner added a commit that referenced this issue Mar 1, 2024
@frankmorgner
doc: generalize README.md
c746496 
Note the use of http:https://htmlpreview.github.io for rendering HTML pages from Github.
From now on, no more modification to README.md should be needed on releases, as we use the Github sticky link
https://github.com/OpenSC/OpenSC/releases/latest

fixes #3035
OpenSC 0.25.0 automation moved this from In progress to Done Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
No open projects
OpenSC 0.25.0
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: generalize README.md frankmorgner/OpenSC
3 participants
@frankmorgner @Jakuje @msetina