diff --git a/CHANGELOG.md b/CHANGELOG.md index de773be..7650e05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,218 +2,237 @@ -## [1.0.1](https://github.com/Nagidal/hatch-semver/tree/1.0.1) - 2022-11-17 +## [2.0.0](https://github.com/fleetingbytes/hatch-semver/tree/2.0.0) - 2024-02-03 ### Documentation -- Fixed typos and errors in the documentation [#59](https://github.com/Nagidal/hatch-semver/issues/59) -- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/Nagidal/hatch-semver/issues/64) +- fix links in the changelog [#76](https://github.com/fleetingbytes/hatch-semver/issues/76) +- fix links in readme [#77](https://github.com/fleetingbytes/hatch-semver/issues/77) +- doc: link to a python-semver bug [#78](https://github.com/fleetingbytes/hatch-semver/issues/78) + + +### New Features + +- use python-semver 3 [#75](https://github.com/fleetingbytes/hatch-semver/issues/75) + + +### Development Details + +- use normal hatchling in `pyproject.toml` [#79](https://github.com/fleetingbytes/hatch-semver/issues/79) + +## [1.0.1](https://github.com/fleetingbytes/hatch-semver/tree/1.0.1) - 2022-11-17 + + +### Documentation + +- Fixed typos and errors in the documentation [#59](https://github.com/fleetingbytes/hatch-semver/issues/59) +- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/fleetingbytes/hatch-semver/issues/64) ### Development Details -- Set current date in `__about__.py` [#61](https://github.com/Nagidal/hatch-semver/issues/61) -- Wrote a test for current date in `__about__.py` [#62](https://github.com/Nagidal/hatch-semver/issues/62) -- Wrote a test for current version in the changelog [#63](https://github.com/Nagidal/hatch-semver/issues/63) +- Set current date in `__about__.py` [#61](https://github.com/fleetingbytes/hatch-semver/issues/61) +- Wrote a test for current date in `__about__.py` [#62](https://github.com/fleetingbytes/hatch-semver/issues/62) +- Wrote a test for current version in the changelog [#63](https://github.com/fleetingbytes/hatch-semver/issues/63) -## [1.0.0](https://github.com/Nagidal/hatch-semver/tree/1.0.0) - 2022-11-17 +## [1.0.0](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0) - 2022-11-17 ### New Features -- Released v1.0.0 [#57](https://github.com/Nagidal/hatch-semver/issues/57) +- Released v1.0.0 [#57](https://github.com/fleetingbytes/hatch-semver/issues/57) -## [1.0.0-rc.4](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.4) - 2022-11-16 +## [1.0.0-rc.4](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.4) - 2022-11-16 ### Documentation -- Renamed User Documentation Workflow to Master PR Closed [#53](https://github.com/Nagidal/hatch-semver/issues/53) +- Renamed User Documentation Workflow to Master PR Closed [#53](https://github.com/fleetingbytes/hatch-semver/issues/53) ### Development Details -- Test stage is set up [#51](https://github.com/Nagidal/hatch-semver/issues/51) +- Test stage is set up [#51](https://github.com/fleetingbytes/hatch-semver/issues/51) -## [1.0.0-rc.3](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.3) - 2022-11-16 +## [1.0.0-rc.3](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.3) - 2022-11-16 ### Documentation -- Using admonitions [#44](https://github.com/Nagidal/hatch-semver/issues/44) -- Using a note admonition in `index.md` [#49](https://github.com/Nagidal/hatch-semver/issues/49) +- Using admonitions [#44](https://github.com/fleetingbytes/hatch-semver/issues/44) +- Using a note admonition in `index.md` [#49](https://github.com/fleetingbytes/hatch-semver/issues/49) ### Development Details -- Using actions/checkout@v3 in the CI [#46](https://github.com/Nagidal/hatch-semver/issues/46) -- Using setup-python@v4 in the CI [#47](https://github.com/Nagidal/hatch-semver/issues/47) +- Using actions/checkout@v3 in the CI [#46](https://github.com/fleetingbytes/hatch-semver/issues/46) +- Using setup-python@v4 in the CI [#47](https://github.com/fleetingbytes/hatch-semver/issues/47) -## [1.0.0-rc.2](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.2) - 2022-11-16 +## [1.0.0-rc.2](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.2) - 2022-11-16 ### Documentation -- Using admonitions [#44](https://github.com/Nagidal/hatch-semver/issues/44) +- Using admonitions [#44](https://github.com/fleetingbytes/hatch-semver/issues/44) ### Development Details -- Using actions/checkout@v3 in the CI [#46](https://github.com/Nagidal/hatch-semver/issues/46) -- Using setup-python@v4 in the CI [#47](https://github.com/Nagidal/hatch-semver/issues/47) +- Using actions/checkout@v3 in the CI [#46](https://github.com/fleetingbytes/hatch-semver/issues/46) +- Using setup-python@v4 in the CI [#47](https://github.com/fleetingbytes/hatch-semver/issues/47) -## [1.0.0-rc.1](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.1) - 2022-11-16 +## [1.0.0-rc.1](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.1) - 2022-11-16 ### Documentation -- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/Nagidal/hatch-semver/issues/35) -- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/Nagidal/hatch-semver/issues/36) -- Updated links to published documentation in `README.md` [#43](https://github.com/Nagidal/hatch-semver/issues/43) +- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/fleetingbytes/hatch-semver/issues/35) +- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/fleetingbytes/hatch-semver/issues/36) +- Updated links to published documentation in `README.md` [#43](https://github.com/fleetingbytes/hatch-semver/issues/43) ### Development Details -- Deleted unnecessary copy of the documentation [#41](https://github.com/Nagidal/hatch-semver/issues/41) -- Better documentation pipeline [#42](https://github.com/Nagidal/hatch-semver/issues/42) +- Deleted unnecessary copy of the documentation [#41](https://github.com/fleetingbytes/hatch-semver/issues/41) +- Better documentation pipeline [#42](https://github.com/fleetingbytes/hatch-semver/issues/42) -## [0.2.4](https://github.com/Nagidal/hatch-semver/tree/0.2.4) - 2022-11-15 +## [0.2.4](https://github.com/fleetingbytes/hatch-semver/tree/0.2.4) - 2022-11-15 ### Development Details -- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/Nagidal/hatch-semver/issues/35) -- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/Nagidal/hatch-semver/issues/36) +- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/fleetingbytes/hatch-semver/issues/35) +- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/fleetingbytes/hatch-semver/issues/36) -## [0.2.4-rc.1](https://github.com/Nagidal/hatch-semver/tree/0.2.4-rc.1) - 2022-11-15 +## [0.2.4-rc.1](https://github.com/fleetingbytes/hatch-semver/tree/0.2.4-rc.1) - 2022-11-15 ### Development Details -- Use hatch-semver for versioning [#33](https://github.com/Nagidal/hatch-semver/issues/33) +- Use hatch-semver for versioning [#33](https://github.com/fleetingbytes/hatch-semver/issues/33) -## [0.2.3](https://github.com/Nagidal/hatch-semver/tree/0.2.3) - 2022-11-15 +## [0.2.3](https://github.com/fleetingbytes/hatch-semver/tree/0.2.3) - 2022-11-15 ### Documentation -- Separated home.md from README.md [#31](https://github.com/Nagidal/hatch-semver/issues/31) +- Separated home.md from README.md [#31](https://github.com/fleetingbytes/hatch-semver/issues/31) -## [0.2.2](https://github.com/Nagidal/hatch-semver/tree/0.2.2) - 2022-11-15 +## [0.2.2](https://github.com/fleetingbytes/hatch-semver/tree/0.2.2) - 2022-11-15 ### Documentation -- Removed api-docs [#29](https://github.com/Nagidal/hatch-semver/issues/29) +- Removed api-docs [#29](https://github.com/fleetingbytes/hatch-semver/issues/29) -## [0.2.1](https://github.com/Nagidal/hatch-semver/tree/0.2.1) - 2022-11-15 +## [0.2.1](https://github.com/fleetingbytes/hatch-semver/tree/0.2.1) - 2022-11-15 ### Documentation -- Moved user-docs to docs [#27](https://github.com/Nagidal/hatch-semver/issues/27) +- Moved user-docs to docs [#27](https://github.com/fleetingbytes/hatch-semver/issues/27) -## [0.2.0](https://github.com/Nagidal/hatch-semver/tree/0.2.0) - 2022-11-15 +## [0.2.0](https://github.com/fleetingbytes/hatch-semver/tree/0.2.0) - 2022-11-15 ### Documentation -- Wrote user and api documentation [#25](https://github.com/Nagidal/hatch-semver/issues/25) +- Wrote user and api documentation [#25](https://github.com/fleetingbytes/hatch-semver/issues/25) -## [0.1.0](https://github.com/Nagidal/hatch-semver/tree/0.1.0) - 2022-11-13 +## [0.1.0](https://github.com/fleetingbytes/hatch-semver/tree/0.1.0) - 2022-11-13 ### New Features -- Added inline options for prerelease and build tokens [#23](https://github.com/Nagidal/hatch-semver/issues/23) +- Added inline options for prerelease and build tokens [#23](https://github.com/fleetingbytes/hatch-semver/issues/23) ### Bugfixes -- Fixed undefined ValeError [#16](https://github.com/Nagidal/hatch-semver/issues/16) -- Can bump prereleases now [#17](https://github.com/Nagidal/hatch-semver/issues/17) -- Can bump builds now [#18](https://github.com/Nagidal/hatch-semver/issues/18) -- Can update version to release [#22](https://github.com/Nagidal/hatch-semver/issues/22) +- Fixed undefined ValeError [#16](https://github.com/fleetingbytes/hatch-semver/issues/16) +- Can bump prereleases now [#17](https://github.com/fleetingbytes/hatch-semver/issues/17) +- Can bump builds now [#18](https://github.com/fleetingbytes/hatch-semver/issues/18) +- Can update version to release [#22](https://github.com/fleetingbytes/hatch-semver/issues/22) ### Development Details -- Created tests [#19](https://github.com/Nagidal/hatch-semver/issues/19) +- Created tests [#19](https://github.com/fleetingbytes/hatch-semver/issues/19) -## [0.0.8](https://github.com/Nagidal/hatch-semver/tree/0.0.8) - 2022-11-10 +## [0.0.8](https://github.com/fleetingbytes/hatch-semver/tree/0.0.8) - 2022-11-10 ### Bugfixes -- Fixed another ValueError when bumping major version [#14](https://github.com/Nagidal/hatch-semver/issues/14) +- Fixed another ValueError when bumping major version [#14](https://github.com/fleetingbytes/hatch-semver/issues/14) -## [0.0.7](https://github.com/Nagidal/hatch-semver/tree/0.0.7) - 2022-11-10 +## [0.0.7](https://github.com/fleetingbytes/hatch-semver/tree/0.0.7) - 2022-11-10 ### Bugfixes -- Fixed NameError when bumping version [#12](https://github.com/Nagidal/hatch-semver/issues/12) +- Fixed NameError when bumping version [#12](https://github.com/fleetingbytes/hatch-semver/issues/12) -## [0.0.6](https://github.com/Nagidal/hatch-semver/tree/0.0.6) - 2022-11-10 +## [0.0.6](https://github.com/fleetingbytes/hatch-semver/tree/0.0.6) - 2022-11-10 ### Bugfixes -- Major version should be bumpable now [#10](https://github.com/Nagidal/hatch-semver/issues/10) +- Major version should be bumpable now [#10](https://github.com/fleetingbytes/hatch-semver/issues/10) -## [0.0.5](https://github.com/Nagidal/hatch-semver/tree/0.0.5) - 2022-11-10 +## [0.0.5](https://github.com/fleetingbytes/hatch-semver/tree/0.0.5) - 2022-11-10 No significant changes. -## [0.0.4](https://github.com/Nagidal/hatch-semver/tree/0.0.4) - 2022-11-10 +## [0.0.4](https://github.com/fleetingbytes/hatch-semver/tree/0.0.4) - 2022-11-10 ### Development Details -- Plugin structure is ready, should know how to bump major, minor, patch [#2](https://github.com/Nagidal/hatch-semver/issues/2) +- Plugin structure is ready, should know how to bump major, minor, patch [#2](https://github.com/fleetingbytes/hatch-semver/issues/2) ### Documentation -- Better readme, but not final [#8](https://github.com/Nagidal/hatch-semver/issues/8) +- Better readme, but not final [#8](https://github.com/fleetingbytes/hatch-semver/issues/8) -## [0.0.3](https://github.com/Nagidal/hatch-semver/tree/0.0.3) - 2022-11-10 +## [0.0.3](https://github.com/fleetingbytes/hatch-semver/tree/0.0.3) - 2022-11-10 ### Bugfixes -- Renamed module to hatch_semver [#6](https://github.com/Nagidal/hatch-semver/issues/6) +- Renamed module to hatch_semver [#6](https://github.com/fleetingbytes/hatch-semver/issues/6) -## [0.0.2](https://github.com/Nagidal/hatch-semver/tree/0.0.2) - 2022-11-10 +## [0.0.2](https://github.com/fleetingbytes/hatch-semver/tree/0.0.2) - 2022-11-10 ### Development Details -- Prepared project [#1](https://github.com/Nagidal/hatch-semver/issues/1) +- Prepared project [#1](https://github.com/fleetingbytes/hatch-semver/issues/1) ### Bugfixes -- Fixed plugin hook path [#4](https://github.com/Nagidal/hatch-semver/issues/4) +- Fixed plugin hook path [#4](https://github.com/fleetingbytes/hatch-semver/issues/4) diff --git a/README.md b/README.md index 4b00dd1..8e7a9ac 100644 --- a/README.md +++ b/README.md @@ -58,5 +58,5 @@ See the [command reference][commands] for all the commands in full detail. If yo [python-semver]: https://github.com/python-semver/python-semver/tree/maint/v2 [semver-regex]: https://regex101.com/r/Ly7O1x/3/ [semver]: https://semver.org/ -[commands]: https://nagidal.github.io/hatch-semver/user_guide/1-commands/ -[comparison]: https://nagidal.github.io/hatch-semver/user_guide/2-migrating-to-semver/ +[commands]: https://fleetingbytes.github.io/hatch-semver/user_guide/1-commands/ +[comparison]: https://fleetingbytes.github.io/hatch-semver/user_guide/2-migrating-to-semver/ diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index de773be..7650e05 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,218 +2,237 @@ -## [1.0.1](https://github.com/Nagidal/hatch-semver/tree/1.0.1) - 2022-11-17 +## [2.0.0](https://github.com/fleetingbytes/hatch-semver/tree/2.0.0) - 2024-02-03 ### Documentation -- Fixed typos and errors in the documentation [#59](https://github.com/Nagidal/hatch-semver/issues/59) -- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/Nagidal/hatch-semver/issues/64) +- fix links in the changelog [#76](https://github.com/fleetingbytes/hatch-semver/issues/76) +- fix links in readme [#77](https://github.com/fleetingbytes/hatch-semver/issues/77) +- doc: link to a python-semver bug [#78](https://github.com/fleetingbytes/hatch-semver/issues/78) + + +### New Features + +- use python-semver 3 [#75](https://github.com/fleetingbytes/hatch-semver/issues/75) + + +### Development Details + +- use normal hatchling in `pyproject.toml` [#79](https://github.com/fleetingbytes/hatch-semver/issues/79) + +## [1.0.1](https://github.com/fleetingbytes/hatch-semver/tree/1.0.1) - 2022-11-17 + + +### Documentation + +- Fixed typos and errors in the documentation [#59](https://github.com/fleetingbytes/hatch-semver/issues/59) +- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/fleetingbytes/hatch-semver/issues/64) ### Development Details -- Set current date in `__about__.py` [#61](https://github.com/Nagidal/hatch-semver/issues/61) -- Wrote a test for current date in `__about__.py` [#62](https://github.com/Nagidal/hatch-semver/issues/62) -- Wrote a test for current version in the changelog [#63](https://github.com/Nagidal/hatch-semver/issues/63) +- Set current date in `__about__.py` [#61](https://github.com/fleetingbytes/hatch-semver/issues/61) +- Wrote a test for current date in `__about__.py` [#62](https://github.com/fleetingbytes/hatch-semver/issues/62) +- Wrote a test for current version in the changelog [#63](https://github.com/fleetingbytes/hatch-semver/issues/63) -## [1.0.0](https://github.com/Nagidal/hatch-semver/tree/1.0.0) - 2022-11-17 +## [1.0.0](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0) - 2022-11-17 ### New Features -- Released v1.0.0 [#57](https://github.com/Nagidal/hatch-semver/issues/57) +- Released v1.0.0 [#57](https://github.com/fleetingbytes/hatch-semver/issues/57) -## [1.0.0-rc.4](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.4) - 2022-11-16 +## [1.0.0-rc.4](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.4) - 2022-11-16 ### Documentation -- Renamed User Documentation Workflow to Master PR Closed [#53](https://github.com/Nagidal/hatch-semver/issues/53) +- Renamed User Documentation Workflow to Master PR Closed [#53](https://github.com/fleetingbytes/hatch-semver/issues/53) ### Development Details -- Test stage is set up [#51](https://github.com/Nagidal/hatch-semver/issues/51) +- Test stage is set up [#51](https://github.com/fleetingbytes/hatch-semver/issues/51) -## [1.0.0-rc.3](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.3) - 2022-11-16 +## [1.0.0-rc.3](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.3) - 2022-11-16 ### Documentation -- Using admonitions [#44](https://github.com/Nagidal/hatch-semver/issues/44) -- Using a note admonition in `index.md` [#49](https://github.com/Nagidal/hatch-semver/issues/49) +- Using admonitions [#44](https://github.com/fleetingbytes/hatch-semver/issues/44) +- Using a note admonition in `index.md` [#49](https://github.com/fleetingbytes/hatch-semver/issues/49) ### Development Details -- Using actions/checkout@v3 in the CI [#46](https://github.com/Nagidal/hatch-semver/issues/46) -- Using setup-python@v4 in the CI [#47](https://github.com/Nagidal/hatch-semver/issues/47) +- Using actions/checkout@v3 in the CI [#46](https://github.com/fleetingbytes/hatch-semver/issues/46) +- Using setup-python@v4 in the CI [#47](https://github.com/fleetingbytes/hatch-semver/issues/47) -## [1.0.0-rc.2](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.2) - 2022-11-16 +## [1.0.0-rc.2](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.2) - 2022-11-16 ### Documentation -- Using admonitions [#44](https://github.com/Nagidal/hatch-semver/issues/44) +- Using admonitions [#44](https://github.com/fleetingbytes/hatch-semver/issues/44) ### Development Details -- Using actions/checkout@v3 in the CI [#46](https://github.com/Nagidal/hatch-semver/issues/46) -- Using setup-python@v4 in the CI [#47](https://github.com/Nagidal/hatch-semver/issues/47) +- Using actions/checkout@v3 in the CI [#46](https://github.com/fleetingbytes/hatch-semver/issues/46) +- Using setup-python@v4 in the CI [#47](https://github.com/fleetingbytes/hatch-semver/issues/47) -## [1.0.0-rc.1](https://github.com/Nagidal/hatch-semver/tree/1.0.0-rc.1) - 2022-11-16 +## [1.0.0-rc.1](https://github.com/fleetingbytes/hatch-semver/tree/1.0.0-rc.1) - 2022-11-16 ### Documentation -- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/Nagidal/hatch-semver/issues/35) -- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/Nagidal/hatch-semver/issues/36) -- Updated links to published documentation in `README.md` [#43](https://github.com/Nagidal/hatch-semver/issues/43) +- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/fleetingbytes/hatch-semver/issues/35) +- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/fleetingbytes/hatch-semver/issues/36) +- Updated links to published documentation in `README.md` [#43](https://github.com/fleetingbytes/hatch-semver/issues/43) ### Development Details -- Deleted unnecessary copy of the documentation [#41](https://github.com/Nagidal/hatch-semver/issues/41) -- Better documentation pipeline [#42](https://github.com/Nagidal/hatch-semver/issues/42) +- Deleted unnecessary copy of the documentation [#41](https://github.com/fleetingbytes/hatch-semver/issues/41) +- Better documentation pipeline [#42](https://github.com/fleetingbytes/hatch-semver/issues/42) -## [0.2.4](https://github.com/Nagidal/hatch-semver/tree/0.2.4) - 2022-11-15 +## [0.2.4](https://github.com/fleetingbytes/hatch-semver/tree/0.2.4) - 2022-11-15 ### Development Details -- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/Nagidal/hatch-semver/issues/35) -- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/Nagidal/hatch-semver/issues/36) +- Using PowerShell instead of cmd commands in pyproject [#35](https://github.com/fleetingbytes/hatch-semver/issues/35) +- Added githooks to the repo. Set your core.hookspath to `.githooks` [#36](https://github.com/fleetingbytes/hatch-semver/issues/36) -## [0.2.4-rc.1](https://github.com/Nagidal/hatch-semver/tree/0.2.4-rc.1) - 2022-11-15 +## [0.2.4-rc.1](https://github.com/fleetingbytes/hatch-semver/tree/0.2.4-rc.1) - 2022-11-15 ### Development Details -- Use hatch-semver for versioning [#33](https://github.com/Nagidal/hatch-semver/issues/33) +- Use hatch-semver for versioning [#33](https://github.com/fleetingbytes/hatch-semver/issues/33) -## [0.2.3](https://github.com/Nagidal/hatch-semver/tree/0.2.3) - 2022-11-15 +## [0.2.3](https://github.com/fleetingbytes/hatch-semver/tree/0.2.3) - 2022-11-15 ### Documentation -- Separated home.md from README.md [#31](https://github.com/Nagidal/hatch-semver/issues/31) +- Separated home.md from README.md [#31](https://github.com/fleetingbytes/hatch-semver/issues/31) -## [0.2.2](https://github.com/Nagidal/hatch-semver/tree/0.2.2) - 2022-11-15 +## [0.2.2](https://github.com/fleetingbytes/hatch-semver/tree/0.2.2) - 2022-11-15 ### Documentation -- Removed api-docs [#29](https://github.com/Nagidal/hatch-semver/issues/29) +- Removed api-docs [#29](https://github.com/fleetingbytes/hatch-semver/issues/29) -## [0.2.1](https://github.com/Nagidal/hatch-semver/tree/0.2.1) - 2022-11-15 +## [0.2.1](https://github.com/fleetingbytes/hatch-semver/tree/0.2.1) - 2022-11-15 ### Documentation -- Moved user-docs to docs [#27](https://github.com/Nagidal/hatch-semver/issues/27) +- Moved user-docs to docs [#27](https://github.com/fleetingbytes/hatch-semver/issues/27) -## [0.2.0](https://github.com/Nagidal/hatch-semver/tree/0.2.0) - 2022-11-15 +## [0.2.0](https://github.com/fleetingbytes/hatch-semver/tree/0.2.0) - 2022-11-15 ### Documentation -- Wrote user and api documentation [#25](https://github.com/Nagidal/hatch-semver/issues/25) +- Wrote user and api documentation [#25](https://github.com/fleetingbytes/hatch-semver/issues/25) -## [0.1.0](https://github.com/Nagidal/hatch-semver/tree/0.1.0) - 2022-11-13 +## [0.1.0](https://github.com/fleetingbytes/hatch-semver/tree/0.1.0) - 2022-11-13 ### New Features -- Added inline options for prerelease and build tokens [#23](https://github.com/Nagidal/hatch-semver/issues/23) +- Added inline options for prerelease and build tokens [#23](https://github.com/fleetingbytes/hatch-semver/issues/23) ### Bugfixes -- Fixed undefined ValeError [#16](https://github.com/Nagidal/hatch-semver/issues/16) -- Can bump prereleases now [#17](https://github.com/Nagidal/hatch-semver/issues/17) -- Can bump builds now [#18](https://github.com/Nagidal/hatch-semver/issues/18) -- Can update version to release [#22](https://github.com/Nagidal/hatch-semver/issues/22) +- Fixed undefined ValeError [#16](https://github.com/fleetingbytes/hatch-semver/issues/16) +- Can bump prereleases now [#17](https://github.com/fleetingbytes/hatch-semver/issues/17) +- Can bump builds now [#18](https://github.com/fleetingbytes/hatch-semver/issues/18) +- Can update version to release [#22](https://github.com/fleetingbytes/hatch-semver/issues/22) ### Development Details -- Created tests [#19](https://github.com/Nagidal/hatch-semver/issues/19) +- Created tests [#19](https://github.com/fleetingbytes/hatch-semver/issues/19) -## [0.0.8](https://github.com/Nagidal/hatch-semver/tree/0.0.8) - 2022-11-10 +## [0.0.8](https://github.com/fleetingbytes/hatch-semver/tree/0.0.8) - 2022-11-10 ### Bugfixes -- Fixed another ValueError when bumping major version [#14](https://github.com/Nagidal/hatch-semver/issues/14) +- Fixed another ValueError when bumping major version [#14](https://github.com/fleetingbytes/hatch-semver/issues/14) -## [0.0.7](https://github.com/Nagidal/hatch-semver/tree/0.0.7) - 2022-11-10 +## [0.0.7](https://github.com/fleetingbytes/hatch-semver/tree/0.0.7) - 2022-11-10 ### Bugfixes -- Fixed NameError when bumping version [#12](https://github.com/Nagidal/hatch-semver/issues/12) +- Fixed NameError when bumping version [#12](https://github.com/fleetingbytes/hatch-semver/issues/12) -## [0.0.6](https://github.com/Nagidal/hatch-semver/tree/0.0.6) - 2022-11-10 +## [0.0.6](https://github.com/fleetingbytes/hatch-semver/tree/0.0.6) - 2022-11-10 ### Bugfixes -- Major version should be bumpable now [#10](https://github.com/Nagidal/hatch-semver/issues/10) +- Major version should be bumpable now [#10](https://github.com/fleetingbytes/hatch-semver/issues/10) -## [0.0.5](https://github.com/Nagidal/hatch-semver/tree/0.0.5) - 2022-11-10 +## [0.0.5](https://github.com/fleetingbytes/hatch-semver/tree/0.0.5) - 2022-11-10 No significant changes. -## [0.0.4](https://github.com/Nagidal/hatch-semver/tree/0.0.4) - 2022-11-10 +## [0.0.4](https://github.com/fleetingbytes/hatch-semver/tree/0.0.4) - 2022-11-10 ### Development Details -- Plugin structure is ready, should know how to bump major, minor, patch [#2](https://github.com/Nagidal/hatch-semver/issues/2) +- Plugin structure is ready, should know how to bump major, minor, patch [#2](https://github.com/fleetingbytes/hatch-semver/issues/2) ### Documentation -- Better readme, but not final [#8](https://github.com/Nagidal/hatch-semver/issues/8) +- Better readme, but not final [#8](https://github.com/fleetingbytes/hatch-semver/issues/8) -## [0.0.3](https://github.com/Nagidal/hatch-semver/tree/0.0.3) - 2022-11-10 +## [0.0.3](https://github.com/fleetingbytes/hatch-semver/tree/0.0.3) - 2022-11-10 ### Bugfixes -- Renamed module to hatch_semver [#6](https://github.com/Nagidal/hatch-semver/issues/6) +- Renamed module to hatch_semver [#6](https://github.com/fleetingbytes/hatch-semver/issues/6) -## [0.0.2](https://github.com/Nagidal/hatch-semver/tree/0.0.2) - 2022-11-10 +## [0.0.2](https://github.com/fleetingbytes/hatch-semver/tree/0.0.2) - 2022-11-10 ### Development Details -- Prepared project [#1](https://github.com/Nagidal/hatch-semver/issues/1) +- Prepared project [#1](https://github.com/fleetingbytes/hatch-semver/issues/1) ### Bugfixes -- Fixed plugin hook path [#4](https://github.com/Nagidal/hatch-semver/issues/4) +- Fixed plugin hook path [#4](https://github.com/fleetingbytes/hatch-semver/issues/4) diff --git a/docs/index.md b/docs/index.md index 31518a5..5ae0301 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ Introduce hatch-semver as a build-dependency to your project (in your `pyproject ```toml [build-system] requires = [ - "hatchling>=1.8.0", + "hatchling", "hatch-semver", ] build-backend = "hatchling.build" diff --git a/docs/user_guide/1-commands.md b/docs/user_guide/1-commands.md index 9da9b85..eec9414 100644 --- a/docs/user_guide/1-commands.md +++ b/docs/user_guide/1-commands.md @@ -76,7 +76,7 @@ If the [version core][bnf] is bumped before the pre-release bump, the pre-releas ### Alphanumeric Pre-Release Identifiers -If pre-release identifiers are present but the last one is an [alphanumeric identifier][bnf]—i.e. not a number—it **will not be bumped** and no further identifiers are introduced (current [python-semver][python-semver] behavior). +If pre-release identifiers are present but the last one is an [alphanumeric identifier][bnf]—i.e. not a number—it **will not be bumped** and no further identifiers are introduced (current [python-semver][python-semver] behavior[issue][issue]). This will normally result in a `ValidationError`, unless you have turned off [validate-bump][validation] in your hatch version settings. | Old Version | Command | validate-bump | New Version | @@ -175,7 +175,7 @@ Similar to the [alpha and beta][ab-short] shortcuts, `dev` is not an alias, so d ### Alphanumeric Build Identifiers -Similar to [python-semver's][python-semver] inability to bump alphanumeric pre-release identifiers, alphanumeric build identifiers will also not be bumped. +Similar to [python-semver's][python-semver] inability to bump alphanumeric pre-release identifiers, alphanumeric build identifiers will also not be bumped [issue][issue]. The returned result is the exact same version. A ValidationError is not raised because when bumping or changing build identifiers, equal precedece of the old and new version is sufficient. @@ -203,6 +203,7 @@ It is therefore OK to temporarily violate the version precedence rule for the in [bnf]: https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions [python-semver]: https://github.com/python-semver/python-semver [bug]: https://github.com/python-semver/python-semver/issues/339 +[issue]: https://github.com/python-semver/python-semver/issues/369 [specific-version]: #specific-version [semver-regex]: https://regex101.com/r/Ly7O1x/3/ [chained-commands]: #chained-commands diff --git a/pyproject.toml b/pyproject.toml index 65f73e2..9e904d2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [build-system] requires = [ - "hatchling>=1.8.0", + "hatchling", "hatch-semver", ] build-backend = "hatchling.build" @@ -24,9 +24,9 @@ keywords = [ ] classifiers = [ - "Development Status :: 3 - Alpha", + #"Development Status :: 3 - Alpha", #"Development Status :: 4 - Beta", - #"Development Status :: 5 - Production/Stable", + "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Topic :: Software Development", "Framework :: Hatch", @@ -41,7 +41,7 @@ classifiers = [ dependencies = [ "hatchling", - "semver ~= 2.13.0", + "semver", ] dynamic = [ @@ -49,9 +49,9 @@ dynamic = [ ] [project.urls] -Homepage = "https://nagidal.github.io/hatch-semver/" -Repository = "https://github.com/Nagidal/hatch-semver" -Issues = "https://github.com/Nagidal/hatch-semver/issues" +Homepage = "https://fleetingbytes.github.io/hatch-semver/" +Repository = "https://github.com/fleetingbytes/hatch-semver" +Issues = "https://github.com/fleetingbytes/hatch-semver/issues" PyPI = "https://pypi.org/project/hatch-semver/" [project.entry-points.hatch] @@ -112,13 +112,13 @@ userve = [ ] tc = [ "towncrier build --yes", - "Copy-Item -path ./CHANGELOG.md -destination ./docs -force", + #"Copy-Item -path ./CHANGELOG.md -destination ./docs -force", "git add --update", "git commit --message \"updated changelog\"" ] [[tool.hatch.envs.test.matrix]] -python = ["310"] +python = ["311"] [tool.coverage.run] branch = true @@ -146,8 +146,8 @@ filename = "CHANGELOG.md" start_string = "\n" underlines = ["", "", ""] template = "changelog.d/changelog_template.jinja" -title_format = "## [{version}](https://github.com/Nagidal/hatch-semver/tree/{version}) - {project_date}" -issue_format = "[#{issue}](https://github.com/Nagidal/hatch-semver/issues/{issue})" +title_format = "## [{version}](https://github.com/fleetingbytes/hatch-semver/tree/{version}) - {project_date}" +issue_format = "[#{issue}](https://github.com/fleetingbytes/hatch-semver/issues/{issue})" orphan_prefix = "+" [tool.towncrier.fragment.doc] diff --git a/src/hatch_semver/__about__.py b/src/hatch_semver/__about__.py index 1c798df..1724269 100644 --- a/src/hatch_semver/__about__.py +++ b/src/hatch_semver/__about__.py @@ -7,5 +7,5 @@ __author_email__ = "sven.siegmund@gmail.com" __maintainer__ = __author__ __maintainer_email__ = __author_email__ -__release_date__ = date(year=2022, month=11, day=17) -__version__ = "1.0.1" +__release_date__ = date(year=2024, month=2, day=3) +__version__ = "2.0.0" diff --git a/src/hatch_semver/semver_scheme.py b/src/hatch_semver/semver_scheme.py index 3ebf075..3506bf7 100644 --- a/src/hatch_semver/semver_scheme.py +++ b/src/hatch_semver/semver_scheme.py @@ -9,7 +9,7 @@ from typing import Mapping from hatchling.version.scheme.plugin.interface import VersionSchemeInterface -from semver import VersionInfo +from semver import Version from .bump_instruction import BumpInstruction from .errors import ValidationError @@ -60,7 +60,7 @@ def update(self, desired_version: str, original_version: str, version_data: Mapp """ if not desired_version: return original_version - original_version = VersionInfo.parse(original_version) + original_version = Version.parse(original_version) current_version = deepcopy(original_version) instructions: str = desired_version validate = self.config.get("validate-bump", True) @@ -82,7 +82,7 @@ def update(self, desired_version: str, original_version: str, version_data: Mapp # To avoid this, we check if nothing but the metadata changed. # if so, we will pretend that last_bump_was_build temp_old_version = deepcopy(current_version) - current_version = VersionInfo.parse(bi.version_part) + current_version = Version.parse(bi.version_part) if temp_old_version == current_version: last_bump_was_build = True rc_bumps_patch = False @@ -100,7 +100,7 @@ def update(self, desired_version: str, original_version: str, version_data: Mapp return str(current_version) def validate_bump( - self, current_version: VersionInfo, original_version: VersionInfo, bumped_build: bool + self, current_version: Version, original_version: Version, bumped_build: bool ) -> None: """ Validates if the current version is a valid successor of the original version.