Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bump-my-version for managing updating release versions #91

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

StephanieKemna
Copy link
Collaborator

Description

Resolves #90

We had no system for how to update the release nr in multiple files, apart from that I recently documented that in the README.
bump-my-version should allow for doing this automatically when we create a release.

Updated dependencies in pyproject.toml to include bump-my-version (do a uv sync -U to get it).

How Has This Been Tested?

  • uv run bump-my-version bump patch --dry-run -vv --allow-dirty

Developer Checklist (before requesting PR review)

  • My code follows the style guidelines of this project
  • My changes generate no new warnings
  • [n/a] Any dependent changes have been merged and published in downstream modules

I have:

  • [n/a] commented my code, particularly in hard-to-understand areas
  • performed a self-review of my own code
  • not committed unnecessary formatting changes, thereby occluding the actual changes (e.g. change of tab spacing, eol, etc.)
  • made corresponding changes to the documentation
  • added change to CHANGELOG.md
  • [n/a] added tests that prove my fix is effective or that my feature works (for core features)

Reviewer checklist

I have:

  • performed a review of the code
  • tested that the software still works as expected
  • checked updates to documentation
  • checked that the CHANGELOG is updated

@StephanieKemna StephanieKemna added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 20, 2024
@StephanieKemna StephanieKemna self-assigned this Dec 20, 2024
@StephanieKemna StephanieKemna marked this pull request as draft December 20, 2024 12:43
@StephanieKemna
Copy link
Collaborator Author

StephanieKemna commented Dec 20, 2024

@ClaasRostock @davidhjp01 @Jorgelmh ; I made this a draft since I am not 100% sure. I have not dared to run it (apart from a local dry run). I just followed the docs. It has the default config, which I adapted to say which files to change (and how). Then it has the default GitHub action, which I have not tried to run - because I would assume it would update the version before we want that to happen..

I am assuming we want to add this to publish_release or some other workflow - which one would be best?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add bump-my-version
1 participant