Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines the release process by removing unused cargo-release settings and adjusting the GitHub Actions workflow to avoid unwanted auto-commits.
- Stripped out
changelogand legacy git settings from the release config. - Updated the release workflow to soft-reset the auto-generated commit and manually commit the version bump.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .release.toml | Removed the changelog setting and obsolete git-related comments. |
| .github/workflows/release.yml | Added git reset --soft HEAD~1 and relocated commit logic into a new step. |
Comments suppressed due to low confidence (2)
.release.toml:12
- Removing the
changelogsetting disables automatic changelog generation by cargo-release; please ensure there's an alternative process or confirm the removal is intentional.
[release]
.github/workflows/release.yml:87
- [nitpick] Consider removing the inline comment from the
namefield and placing it above the step or in therunblock; step names should remain concise.
- name: Commit and push version bump # We first reset the last commit to avoid the commit made by cargo-release
| env: | ||
| CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} | ||
| run: cargo release patch --execute --no-confirm | ||
| run: cargo release patch --execute --no-confirm # commits but we dont want to commit using cargo-release, so we will git reset soft HEAD~1 |
There was a problem hiding this comment.
Use proper contraction in the comment: replace “dont” with “don't” for clarity.
Suggested change
| run: cargo release patch --execute --no-confirm # commits but we dont want to commit using cargo-release, so we will git reset soft HEAD~1 | |
| run: cargo release patch --execute --no-confirm # commits but we don't want to commit using cargo-release, so we will git reset soft HEAD~1 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #18 +/- ##
=======================================
Coverage 96.90% 96.90%
=======================================
Files 76 76
Lines 1650 1650
=======================================
Hits 1599 1599
Misses 51 51 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
cargo releaseautomatically commits the version bumps, and this cannot be changed. So we let it, but git reset soft it, so that we can commit it and sign it in the Github workflow.