From ddf57ac35ee72c1f7ea104d5c03c17976df055cc Mon Sep 17 00:00:00 2001 From: Nikhil Woodruff <35577657+nikhilwoodruff@users.noreply.github.com> Date: Tue, 22 Oct 2024 11:33:18 +0100 Subject: [PATCH] Bump data to 1.9 (#975) * Bump data to 1.9 * Update contributor guidance * Add guidance --- .github/CONTRIBUTING.md | 19 +++++++++++++++++++ CHANGELOG.md | 7 +++++++ changelog.yaml | 5 +++++ setup.py | 4 ++-- 4 files changed, 33 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 22df24be0..d2a789101 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,6 +24,25 @@ In case of breaking changes, you **must** give details about what features were ## Advertising changes +Our versioning is currently done manually. You should: + +* Add a new entry to the changelog_entry.yaml file. See below for an example. +* Run 'make changelog' to update the changelog.md file. +* Commit and push your changes (this will have changed `CHANGELOG.md`, `changelog.yaml` and `setup.py`). + +### Example of a changelog entry + +```yaml +- bump: minor + changes: + added: + - Added this thing. + changed: + - Changed that thing. + fixed: + - Bug you fixed. +``` + ### Version number We follow the [semantic versioning](http://semver.org/) spec: any change impacts the version number, and the version number conveys API compatibility information **only**. diff --git a/CHANGELOG.md b/CHANGELOG.md index a32444984..118242711 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.10.0] - 2024-10-22 11:24:42 + +### Changed + +- Data bumped to 1.9.0. + ## [2.9.0] - 2024-10-22 08:36:24 ### Changed @@ -1536,6 +1542,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 +[2.10.0]: https://github.com/PolicyEngine/openfisca-uk/compare/2.9.0...2.10.0 [2.9.0]: https://github.com/PolicyEngine/openfisca-uk/compare/2.8.0...2.9.0 [2.8.0]: https://github.com/PolicyEngine/openfisca-uk/compare/2.7.0...2.8.0 [2.7.0]: https://github.com/PolicyEngine/openfisca-uk/compare/2.6.0...2.7.0 diff --git a/changelog.yaml b/changelog.yaml index ee1ed3c56..cd0591e77 100644 --- a/changelog.yaml +++ b/changelog.yaml @@ -1289,3 +1289,8 @@ changed: - UK data updated to 1.8.0. date: 2024-10-22 08:36:24 +- bump: minor + changes: + changed: + - Data bumped to 1.9.0. + date: 2024-10-22 11:24:42 diff --git a/setup.py b/setup.py index ffbc4f421..682f16e6c 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ setup( name="PolicyEngine-UK", - version="2.9.0", + version="2.10.0", author="PolicyEngine", author_email="nikhil@policyengine.org", classifiers=[ @@ -27,7 +27,7 @@ ], install_requires=[ "PolicyEngine-Core>=3.6.4", - "PolicyEngine-UK-Data>=1.8,<1.9", + "PolicyEngine-UK-Data>=1.9,<1.10", "microdf_python", ], extras_require={