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.

Sign up for GitHub

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

Jump to bottom

Drop bump2version for bump-my-version #1557

Closed
2 tasks done
Zeitsperre opened this issue Dec 11, 2023 · 0 comments · Fixed by #1569
Closed
2 tasks done

Drop bump2version for bump-my-version #1557

Zeitsperre opened this issue Dec 11, 2023 · 0 comments · Fixed by #1569
Assignees
@Zeitsperre
Labels
enhancement New feature or request information For development/intsructional purposes standards / conventions Suggestions on ways forward
Milestone
v0.48.0

Comments

@Zeitsperre
Copy link
Collaborator

Zeitsperre commented Dec 11, 2023 •
edited
Loading

Addressing a Problem?

The bump-2-version library (a fork of bumpversion) is sadly unmaintained (last release: October 2020). A new fork that looks promising is bump-my-version. This version brings TOML support to the project, so that's a nice bonus.

I've integrated this fork into the Ouranos Python cookiecutter, but since xclim is not based on this template, any changes need to be ported directly.

Potential Solution

Additional context

Given that the setup.cfg will only house the few flake8 configuration options after changes, we can probably turn this into a .flake8 ini file so that we drop usage of setup.cfg altogether.

Contribution

  • I would be willing/able to open a Pull Request to contribute this feature.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Zeitsperre Zeitsperre added enhancement New feature or request standards / conventions Suggestions on ways forward information For development/intsructional purposes labels Dec 11, 2023
@Zeitsperre Zeitsperre self-assigned this Dec 12, 2023
@tlogan2000 tlogan2000 added this to the v0.48.0 milestone Dec 12, 2023
@Zeitsperre Zeitsperre mentioned this issue Dec 22, 2023
Merged
5 tasks
Zeitsperre added a commit that referenced this issue Dec 29, 2023
@Zeitsperre
Semantic Version v2.0.0 Specification (#1569)
d6dd420 
<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #1556 and fixes #1557 
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [x] CHANGES.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

### What kind of change does this PR introduce?

* `xclim` now adheres to the [Semantic Versioning
2.0.0](https://semver.org/) specification.
* `bump2version` has been replaced with `bump-my-version`
* The `setup.cfg` has been deleted; `flake8` configurations have
migrated to `.flake8` file, and `bumpversion` configuration is now found
in `pyproject.toml`.
* Fixed an issue with the `.gitignore` to properly ignore some
autogenerated files.

### Does this PR introduce a breaking change?

Yes. The versioning system has been adjusted so that patch versions are
not augmented at every push to `xclim` code; instead, the build version
is adjusted.

### Other information:

https://callowayproject.github.io/bump-my-version/
@Zeitsperre Zeitsperre mentioned this issue Jan 9, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Zeitsperre Zeitsperre

Labels
enhancement New feature or request information For development/intsructional purposes standards / conventions Suggestions on ways forward
Projects
None yet
Milestone
v0.48.0
Development

Successfully merging a pull request may close this issue.

Semantic Version v2.0.0 Specification Ouranosinc/xclim
2 participants
@Zeitsperre @tlogan2000