ci: workflow for publishing crates #5105
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
conorsch
commented
Feb 25, 2025
| publish: | ||
| runs-on: buildjet-16vcpu-ubuntu-2204 | ||
| env: | ||
| CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} |
There was a problem hiding this comment.
Added this in the repo settings.
|
|
||
| # Publish the workspace to crates.io. | ||
| - name: publish crates | ||
| run: nix develop --command ./deployments/scripts/publish-crates |
There was a problem hiding this comment.
This script is already in place, and precisely what I've been using locally to handle publication when a new tag is cut.
|
|
||
| # The `rust-toolchain.toml` file dictates which version of rust to setup. | ||
| - name: check rust version | ||
| run: nix develop --command rustc --version |
There was a problem hiding this comment.
Reusing the nix env simply to pull in relevant tooling like cargo-release, so it's pinned to the same version I use locally.
cronokirby
approved these changes
Feb 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Adds a simple workflow to handle publishing the workspace's crates to crates.io. Will run whenever a new tag is pushed to the repo, and publish the crates under that tag.
Issue ticket number and link
Closes #5005. Refs #5104, #4978.
Testing and review
I've been handling the publication step manually, locally, after tagging release, to ensure that the script is stable enough to stick in automation. It's been well behaved for the past few minor releases, so let's try it out in automation. I'll handle verifying behavior post-merge, post-release.
Checklist before requesting a review
I have added guiding text to explain how a reviewer should test these changes.
If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: