Add release workflow for crates.io publishing #21
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,75 @@ | ||||||
| name: Publish to crates.io | ||||||
|
|
||||||
| on: | ||||||
| push: | ||||||
| tags: ['v*'] | ||||||
|
|
||||||
| jobs: | ||||||
| test: | ||||||
| runs-on: ubuntu-24.04 | ||||||
|
|
||||||
| steps: | ||||||
| - name: Print environment (debug) | ||||||
| run: env | ||||||
|
|
||||||
| - name: Fetch sources | ||||||
| uses: actions/checkout@v4 | ||||||
| with: | ||||||
| submodules: recursive | ||||||
|
|
||||||
| - name: Run tests | ||||||
| uses: frequenz-floss/gh-action-cargo-test@v1.0.0 | ||||||
|
|
||||||
| create-github-release: | ||||||
| needs: ["test"] | ||||||
| name: Create GitHub release | ||||||
| runs-on: ubuntu-24.04 | ||||||
| permissions: | ||||||
| # We need write permissions on contents to create GitHub releases and on | ||||||
| # discussions to create the release announcement in the discussion forums | ||||||
| contents: write | ||||||
| discussions: write | ||||||
| steps: | ||||||
| - name: Download RELEASE_NOTES.md | ||||||
| run: | | ||||||
| set -ux | ||||||
| gh api \ | ||||||
| -X GET \ | ||||||
| -f ref=$REF \ | ||||||
| -H "Accept: application/vnd.github.raw" \ | ||||||
| "/repos/$REPOSITORY/contents/RELEASE_NOTES.md" \ | ||||||
| > RELEASE_NOTES.md | ||||||
| env: | ||||||
| REF: ${{ github.ref }} | ||||||
| REPOSITORY: ${{ github.repository }} | ||||||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||
|
|
||||||
| - name: Create GitHub release | ||||||
| run: | | ||||||
| set -ux | ||||||
| extra_opts= | ||||||
| if echo "$REF_NAME" | grep -- -; then extra_opts=" --prerelease"; fi | ||||||
|
There was a problem hiding this comment. The grep command on line 51 will succeed if a hyphen appears anywhere in the tag name, not just in pre-release identifiers (e.g., 'v1.0-alpha', but also 'my-project-v1.0'). Consider using a more precise pattern like
Suggested change
Collaborator
Author
There was a problem hiding this comment. This is copied from repo-config, I'm sure it is fine. |
||||||
| gh release create \ | ||||||
| -R "$REPOSITORY" \ | ||||||
| --notes-file RELEASE_NOTES.md \ | ||||||
| --generate-notes \ | ||||||
| $extra_opts \ | ||||||
| $REF_NAME | ||||||
| env: | ||||||
| REF_NAME: ${{ github.ref_name }} | ||||||
| REPOSITORY: ${{ github.repository }} | ||||||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||
|
|
||||||
| publish: | ||||||
| needs: ["create-github-release"] | ||||||
| runs-on: ubuntu-24.04 | ||||||
| environment: release | ||||||
| permissions: | ||||||
| id-token: write | ||||||
| steps: | ||||||
| - uses: actions/checkout@v5 | ||||||
| - uses: rust-lang/crates-io-auth-action@b7e9a28eded4986ec6b1fa40eeee8f8f165559ec # v1.0.3 | ||||||
| id: auth | ||||||
| - run: cargo publish | ||||||
| env: | ||||||
| CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }} | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent checkout action versions used across the workflow. The test job uses @v4 while the publish job uses @v5. Consider standardizing on @v5 throughout for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would rather wait for dependabot to fix.