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.

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

Tag releases #106

Open
e00E opened this issue Mar 6, 2022 · 2 comments
Open

Tag releases #106

e00E opened this issue Mar 6, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@e00E
Copy link

e00E commented Mar 6, 2022

Please git tag the releases when they are made to crates.io . This makes it easier to look at the source code of a specific version later.
For example c361446 should have been tagged as so in the repository.

@mooman219 mooman219 added the documentation Improvements or additions to documentation label Mar 7, 2022
@mooman219
Copy link
Owner

mooman219 commented Mar 7, 2022

I'll consider it for the next release. I'll checkout if there's a cargo command that'll just do it for me on publish since otherwise I'll forget. Do you have any recommendations?

I have no intention in tagging old releases. I'm sure you can grep for the version bump commits if you really wanted to. Also the commit sha is included in the published package.

@e00E
Copy link
Author

e00E commented Mar 7, 2022

I think it is fine to not tag old releases. I'm not aware of a cargo command that does it for you. What you can do is make CI create the release. Then you automatically trigger those releases based on tags. An example Rust project that does this is Ripgrep https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/release.yml .
If setting up CI this way is overkill you could create something like Release.md or release.sh with a checklist to follow for releases or automatically do the steps in the script.
Edit: Looks like Ripgrep doesn't actually release to crates.io, just to Github. Don't have another crate from the top of my head.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants