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

ci: ensure we bump crate versions for "release worthy" changes #4367

Closed
thomaseizinger opened this issue Aug 21, 2023 · 2 comments · Fixed by #4620
Closed

ci: ensure we bump crate versions for "release worthy" changes #4367

thomaseizinger opened this issue Aug 21, 2023 · 2 comments · Fixed by #4620

Comments

@thomaseizinger
Copy link
Contributor

thomaseizinger commented Aug 21, 2023

We have a policy to bump a crates version if we make a "release worthy" change to it. Normally, this is also accompanied with a changelog entry.

Anything that does not exclusively touch the lockfile is a release worthy change to me. This for example includes #4358.

We should have a CI check that ensures that the crate's version is bumped to $currentPatchOnCratesIo + 1. Such CI check would help us maintainers to remember this policy and also help users in making contributions because they can make self-directed changes based on the CI result.

@thomaseizinger
Copy link
Contributor Author

Some more thoughts:

  • I think we may want to make this check based on git tags and not crates.io otherwise CI is not deterministic and we will have weird failures when backporting things.
  • A check for touching the changelog could also be interesting and I think quite easy. Essentially, all we'd need to do is verify, that the top-most line of the changelog is a version that does not exist as a git tag (if any files for that crate have been touched in that PR).

@thomaseizinger
Copy link
Contributor Author

  • (if any files for that crate have been touched in that PR).

Checking that should be quite easy with the gh CLI. See https://stackoverflow.com/a/68682405.

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

Successfully merging a pull request may close this issue.

1 participant