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 checks to CI that Changelog has been updated and version incremented #165

Open
davidhopkinson26 opened this issue Jan 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@davidhopkinson26
Copy link
Contributor

davidhopkinson26 commented Jan 18, 2024

When making a PR to add a feature to the package we should be updating both CHANGELOG.rst and the version number in __version.py to reflect the changes.

If this is forgotten the we need to make an additional PR to add these changes in before publishing a release, which slows down the release process or if forgotten means we create a release with incorrect documentation (Changelog) or cause the deployment to fail (version update).

Adding a check to the build pipeline that these two files have been updated should prevent this mistake. Having this check in place could also potentially facilitate a move to continuous deployment where a successful PR into main could automatically trigger a release workflow, should we wish to do so.

The following github action may be useful verify-changed-files

@davidhopkinson26 davidhopkinson26 added documentation Improvements or additions to documentation feature New feature or request labels Jan 18, 2024
@davidhopkinson26 davidhopkinson26 changed the title Add checks that Changelog has been updated and version incremented to CI Add checks to CI that Changelog has been updated and version incremented Jan 18, 2024
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 feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant