Update release workflow to mint a release#3087
Merged
namurphy merged 5 commits intoPlasmaPy:mainfrom Aug 7, 2025
Merged
Conversation
github-actions
bot
added
GitHub Actions
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3087 +/- ##
==========================================
- Coverage 95.48% 94.71% -0.78%
==========================================
Files 108 108
Lines 9869 9869
Branches 1501 1501
==========================================
- Hits 9423 9347 -76
- Misses 255 325 +70
- Partials 191 197 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
namurphy
added
the
no changelog entry needed
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
1 participant
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.
This pull request removes
mint-release.ymlin favor of a newprepare-release-pr.ymlworkflow, which will create a pull request with the built changelog and updated metadata.I decided that creating a pull request would give us a chance to review the changelog and metadata in case of any problems.
Changes from previous release process
The revised workflow no longer creates a release branch like
v2024.10.x, which we had been creating in case we ever needed to do a patch release, or if we had a problem building the documentation. However, we haven't used the . The changelog and such was built on the release branch, followed by a pull request to merge the changes back intomain. Because the tag was made on the release branch, it would not show up in the history ofmainif we did a squash merge, which causedplasmapy.__version__to be based off of the incorrect previous tag. If we end up needing to create a release branch of the formv2024.10.x, then we can still create it manually based off of the tagged version for the release.The revised workflow no longer creates a tag that can be selected during the release. Going forward, we will create the tag off of
mainupon doing the release.In the previous release process, we've created separate pull requests to revise the changelog for both style and content. For example, if two PRs produced conflicting changes, the changelog entries could be revised accordingly. Going forward, we can use the newly created pull request to perform a code review for the final changelog just before the release.