Skip to content

Conversation

jimboid
Copy link
Member

@jimboid jimboid commented Aug 15, 2025

Summary

This PR will add the ability to make the release cycle more automated and using more of the features of the repository to improve visibility of the releases and their changes. The changes in the PR are summarised as:

Changes

Renamed the .yaml to be simply release.yaml

Added in the following changes:

  • Added in user input for version. Making a release now, go to actions, click release, click the run trigger and enter new version number and this will trigger the release WF.
  • Version check using semver with that already on pypa to make sure that new version is at least newer
  • Tag the current head of main branch with new version number
  • Make a GH release and attach the changelog, this will be massive on the first release! But will settle down
  • Upload to pypi with flit.

Impact

This should simplify the release process, reduce errors and having to check the versioning format for tags. It forces consistency in how the features of the repo are used, tag, releases etc.

Closes #131

@jimboid jimboid requested a review from harryswift01 August 15, 2025 15:04
@jimboid
Copy link
Member Author

jimboid commented Aug 15, 2025

Have a look here for examples on how this looks

https://github.com/jkalayan/waterEntropy/releases
https://github.com/HECBioSim/Longbow/
https://github.com/PSDI-UK/aiida-gromacs/releases

for a few different examples on where we are applying this

@jimboid jimboid marked this pull request as ready for review August 15, 2025 15:06
@jimboid
Copy link
Member Author

jimboid commented Aug 15, 2025

We will have to eyeball the first time we use the action WF, since the configuration of the repo here is slightly different to the others. I think the way it might fail will be linked to bypassing checks on the repo on the automated PRs, but we will fix that when it comes to it, we are able to specify the actions bot as able to bypass certain checks

Copy link
Contributor

@harryswift01 harryswift01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a much more streamlined and comprehensive way to release CodeEntropy. Everything appears to be in place to ensure we can tag and release the most up-to-date packages as simply and reliably as possible. Thank you very much for implementing this, it's a great improvement!

@harryswift01 harryswift01 added this to the 1.0.0 release milestone Aug 15, 2025
@jimboid jimboid merged commit cce4223 into main Aug 15, 2025
7 checks passed
@jimboid jimboid deleted the 131-improve-release-ci branch August 15, 2025 15:30
jimboid added a commit that referenced this pull request Sep 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve release process CI
2 participants