From 1d2bbdf23aab816cd9d6e26f537b5cec9e39dede Mon Sep 17 00:00:00 2001 From: semantic-release Date: Wed, 3 Jan 2024 20:34:53 +0000 Subject: [PATCH] 8.7.2 Automatically generated by python-semantic-release --- CHANGELOG.md | 1320 +++++++++++++++++----------------- pyproject.toml | 2 +- semantic_release/__init__.py | 2 +- 3 files changed, 675 insertions(+), 649 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b18f6dbc..02a5da796 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,32 @@ +## v8.7.2 (2024-01-03) + +### Build + +* build(deps-dev): bump ruff from 0.1.8 to 0.1.11 (#792) + +Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.8 to 0.1.11. +- [Release notes](https://github.com/astral-sh/ruff/releases) +- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) +- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.8...v0.1.11) + +--- +updated-dependencies: +- dependency-name: ruff + dependency-type: direct:production + update-type: version-update:semver-patch +... + +Signed-off-by: dependabot[bot] <support@github.com> +Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`6835fca`](https://github.com/python-semantic-release/python-semantic-release/commit/6835fcad54b452ac212ee132a8424453c1c1e150)) + +### Fix + +* fix(lint): correct linter errors ([`c9556b0`](https://github.com/python-semantic-release/python-semantic-release/commit/c9556b0ca6df6a61e9ce909d18bc5be8b6154bf8)) + + ## v8.7.1 (2024-01-03) ### Documentation @@ -61,55 +87,55 @@ Git remote url parsing now supports additional formats (ssh, https, file, git) ( * build(deps-dev): bump ruff from 0.1.7 to 0.1.8 (#775) -Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.7 to 0.1.8. -- [Release notes](https://github.com/astral-sh/ruff/releases) -- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) -- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.7...v0.1.8) - ---- -updated-dependencies: -- dependency-name: ruff - dependency-type: direct:production - update-type: version-update:semver-patch -... - -Signed-off-by: dependabot[bot] <support@github.com> +Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.7 to 0.1.8. +- [Release notes](https://github.com/astral-sh/ruff/releases) +- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) +- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.7...v0.1.8) + +--- +updated-dependencies: +- dependency-name: ruff + dependency-type: direct:production + update-type: version-update:semver-patch +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`5efda8a`](https://github.com/python-semantic-release/python-semantic-release/commit/5efda8acfed938d3188cd55678ace20ecac7f798)) * build(deps-dev): bump ruff from 0.1.6 to 0.1.7 (#769) -* build(deps-dev): bump ruff from 0.1.6 to 0.1.7 - -Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.6 to 0.1.7. -- [Release notes](https://github.com/astral-sh/ruff/releases) -- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) -- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.6...v0.1.7) - ---- -updated-dependencies: -- dependency-name: ruff - dependency-type: direct:production - update-type: version-update:semver-patch -... - -Signed-off-by: dependabot[bot] <support@github.com> - -* ci: remove hardcoded ruff version in workflows - ---------- - -Signed-off-by: dependabot[bot] <support@github.com> -Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> +* build(deps-dev): bump ruff from 0.1.6 to 0.1.7 + +Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.6 to 0.1.7. +- [Release notes](https://github.com/astral-sh/ruff/releases) +- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) +- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.6...v0.1.7) + +--- +updated-dependencies: +- dependency-name: ruff + dependency-type: direct:production + update-type: version-update:semver-patch +... + +Signed-off-by: dependabot[bot] <support@github.com> + +* ci: remove hardcoded ruff version in workflows + +--------- + +Signed-off-by: dependabot[bot] <support@github.com> +Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Bernard Cooke <bernard-cooke@hotmail.com> ([`c48c3b3`](https://github.com/python-semantic-release/python-semantic-release/commit/c48c3b370335931d63391d1a4f5802937deff178)) ### Fix * fix(cli): gracefully output configuration validation errors (#772) -* test(fixtures): update example project workflow & add config modifier - -* test(cli-main): add test for raw config validation error - +* test(fixtures): update example project workflow & add config modifier + +* test(cli-main): add test for raw config validation error + * fix(cli): gracefully output configuration validation errors ([`e8c9d51`](https://github.com/python-semantic-release/python-semantic-release/commit/e8c9d516c37466a5dce75a73766d5be0f9e74627)) ### Style @@ -125,26 +151,26 @@ Co-authored-by: Bernard Cooke <bernard-cooke@hotmail.com> ([`c48c3b3`](htt * docs(configuration): adjust wording and improve clarity (#766) -* docs(configuration): fix typo in text - +* docs(configuration): fix typo in text + * docs(configuration): adjust wording and improve clarity ([`6b2fc8c`](https://github.com/python-semantic-release/python-semantic-release/commit/6b2fc8c156e122ee1b43fdb513b2dc3b8fd76724)) ### Fix * fix(config): gracefully fail when repo is in a detached HEAD state (#765) -* fix(config): cleanly handle repository in detached HEAD state - +* fix(config): cleanly handle repository in detached HEAD state + * test(cli-main): add detached head cli test ([`ac4f9aa`](https://github.com/python-semantic-release/python-semantic-release/commit/ac4f9aacb72c99f2479ae33369822faad011a824)) * fix(cmd-version): handle committing of git-ignored file gracefully (#764) -* fix(version): only commit non git-ignored files during version commit - -* test(version): set version file as ignored file - -Tweaks tests to use one committed change file and the version file -as an ignored change file. This allows us to verify that our commit +* fix(version): only commit non git-ignored files during version commit + +* test(version): set version file as ignored file + +Tweaks tests to use one committed change file and the version file +as an ignored change file. This allows us to verify that our commit mechanism does not crash if a file that is changed is ignored by user ([`ea89fa7`](https://github.com/python-semantic-release/python-semantic-release/commit/ea89fa72885e15da91687172355426a22c152513)) ### Style @@ -165,35 +191,35 @@ mechanism does not crash if a file that is changed is ignored by user ([`ea89fa7 * build(deps-dev): bump ruff from 0.1.2 to 0.1.6 (#757) -Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.2 to 0.1.6. -- [Release notes](https://github.com/astral-sh/ruff/releases) -- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) -- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.2...v0.1.6) - ---- -updated-dependencies: -- dependency-name: ruff - dependency-type: direct:production - update-type: version-update:semver-patch -... - -Signed-off-by: dependabot[bot] <support@github.com> +Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.2 to 0.1.6. +- [Release notes](https://github.com/astral-sh/ruff/releases) +- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) +- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.2...v0.1.6) + +--- +updated-dependencies: +- dependency-name: ruff + dependency-type: direct:production + update-type: version-update:semver-patch +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`90db8f1`](https://github.com/python-semantic-release/python-semantic-release/commit/90db8f1bd8986eda1b913cd4bab5abd41192f01f)) * build(deps-dev): update python-gitlab requirement from <4,>=2 to >=2,<5 (#748) -Updates the requirements on [python-gitlab](https://github.com/python-gitlab/python-gitlab) to permit the latest version. -- [Release notes](https://github.com/python-gitlab/python-gitlab/releases) -- [Changelog](https://github.com/python-gitlab/python-gitlab/blob/main/CHANGELOG.md) -- [Commits](https://github.com/python-gitlab/python-gitlab/compare/v2.0.0...v4.1.1) - ---- -updated-dependencies: -- dependency-name: python-gitlab - dependency-type: direct:production -... - -Signed-off-by: dependabot[bot] <support@github.com> +Updates the requirements on [python-gitlab](https://github.com/python-gitlab/python-gitlab) to permit the latest version. +- [Release notes](https://github.com/python-gitlab/python-gitlab/releases) +- [Changelog](https://github.com/python-gitlab/python-gitlab/blob/main/CHANGELOG.md) +- [Commits](https://github.com/python-gitlab/python-gitlab/compare/v2.0.0...v4.1.1) + +--- +updated-dependencies: +- dependency-name: python-gitlab + dependency-type: direct:production +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`a176d62`](https://github.com/python-semantic-release/python-semantic-release/commit/a176d626f28ba68ae8a938b2f04f74da841a7eeb)) * build(deps-dev): bump ruff from 0.0.292 to 0.1.1 ([`9c5bbe0`](https://github.com/python-semantic-release/python-semantic-release/commit/9c5bbe0b0ef96e0fadae9e65918fc8939d0d3e60)) @@ -206,12 +232,12 @@ Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.githu * feat(cmd-version): add `--tag/--no-tag` option to version command (#752) -* fix(version): separate push tags from commit push when not committing changes - -* feat(version): add `--no-tag` option to turn off tag creation - -* test(version): add test for `--tag` option & `--no-tag/commit` - +* fix(version): separate push tags from commit push when not committing changes + +* feat(version): add `--no-tag` option to turn off tag creation + +* test(version): add test for `--tag` option & `--no-tag/commit` + * docs(commands): update `version` subcommand options ([`de6b9ad`](https://github.com/python-semantic-release/python-semantic-release/commit/de6b9ad921e697b5ea2bb2ea8f180893cecca920)) ### Style @@ -286,19 +312,19 @@ GitHub.upload_asset now raises ValueError instead of requests.HTTPError ([`a13a6 * build(deps-dev): bump ruff from 0.0.286 to 0.0.290 (#713) -Bumps [ruff](https://github.com/astral-sh/ruff) from 0.0.286 to 0.0.290. -- [Release notes](https://github.com/astral-sh/ruff/releases) -- [Changelog](https://github.com/astral-sh/ruff/blob/main/BREAKING_CHANGES.md) -- [Commits](https://github.com/astral-sh/ruff/compare/v0.0.286...v0.0.290) - ---- -updated-dependencies: -- dependency-name: ruff - dependency-type: direct:production - update-type: version-update:semver-patch -... - -Signed-off-by: dependabot[bot] <support@github.com> +Bumps [ruff](https://github.com/astral-sh/ruff) from 0.0.286 to 0.0.290. +- [Release notes](https://github.com/astral-sh/ruff/releases) +- [Changelog](https://github.com/astral-sh/ruff/blob/main/BREAKING_CHANGES.md) +- [Commits](https://github.com/astral-sh/ruff/compare/v0.0.286...v0.0.290) + +--- +updated-dependencies: +- dependency-name: ruff + dependency-type: direct:production + update-type: version-update:semver-patch +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`6b288f2`](https://github.com/python-semantic-release/python-semantic-release/commit/6b288f2033366a8a2d6e730938df3606fa5ca5a7)) ### Fix @@ -312,12 +338,12 @@ Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.githu * build(deps-dev): bump importlib-resources from 5.7 to 5.12.0 (#704) -* build(deps-dev): bump importlib-resources from 5.7 to 5.12.0 - -* build(deps-dev): relax importlib-resources requirement - ---------- - +* build(deps-dev): bump importlib-resources from 5.7 to 5.12.0 + +* build(deps-dev): relax importlib-resources requirement + +--------- + Co-authored-by: Bernard Cooke <bernard.cooke@iotics.com> ([`861fe01`](https://github.com/python-semantic-release/python-semantic-release/commit/861fe0119131f69761ae3e06ec46d62e526269d6)) ### Chore @@ -363,50 +389,50 @@ Co-authored-by: github-actions <action@github.com> ([`8a515ca`](https://gi * build(deps-dev): update pytest-xdist requirement (#677) -Updates the requirements on [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) to permit the latest version. -- [Changelog](https://github.com/pytest-dev/pytest-xdist/blob/master/CHANGELOG.rst) -- [Commits](https://github.com/pytest-dev/pytest-xdist/compare/v2.0.0...v3.3.1) - ---- -updated-dependencies: -- dependency-name: pytest-xdist - dependency-type: direct:production -... - -Signed-off-by: dependabot[bot] <support@github.com> +Updates the requirements on [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) to permit the latest version. +- [Changelog](https://github.com/pytest-dev/pytest-xdist/blob/master/CHANGELOG.rst) +- [Commits](https://github.com/pytest-dev/pytest-xdist/compare/v2.0.0...v3.3.1) + +--- +updated-dependencies: +- dependency-name: pytest-xdist + dependency-type: direct:production +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`9ec6321`](https://github.com/python-semantic-release/python-semantic-release/commit/9ec63215c8d60230ff90c06096d8f37956bd156a)) * build(deps-dev): update coverage[toml] requirement (#678) -Updates the requirements on [coverage[toml]](https://github.com/nedbat/coveragepy) to permit the latest version. -- [Release notes](https://github.com/nedbat/coveragepy/releases) -- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) -- [Commits](https://github.com/nedbat/coveragepy/compare/6.0...7.3.0) - ---- -updated-dependencies: -- dependency-name: coverage[toml] - dependency-type: direct:production -... - -Signed-off-by: dependabot[bot] <support@github.com> +Updates the requirements on [coverage[toml]](https://github.com/nedbat/coveragepy) to permit the latest version. +- [Release notes](https://github.com/nedbat/coveragepy/releases) +- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst) +- [Commits](https://github.com/nedbat/coveragepy/compare/6.0...7.3.0) + +--- +updated-dependencies: +- dependency-name: coverage[toml] + dependency-type: direct:production +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`3561a97`](https://github.com/python-semantic-release/python-semantic-release/commit/3561a977fc56ec4bb12c9a894c0072cd8a3519fa)) * build(deps-dev): bump responses from 0.21.0 to 0.23.3 (#680) -Bumps [responses](https://github.com/getsentry/responses) from 0.21.0 to 0.23.3. -- [Release notes](https://github.com/getsentry/responses/releases) -- [Changelog](https://github.com/getsentry/responses/blob/master/CHANGES) -- [Commits](https://github.com/getsentry/responses/compare/0.21.0...0.23.3) - ---- -updated-dependencies: -- dependency-name: responses - dependency-type: direct:production - update-type: version-update:semver-minor -... - -Signed-off-by: dependabot[bot] <support@github.com> +Bumps [responses](https://github.com/getsentry/responses) from 0.21.0 to 0.23.3. +- [Release notes](https://github.com/getsentry/responses/releases) +- [Changelog](https://github.com/getsentry/responses/blob/master/CHANGES) +- [Commits](https://github.com/getsentry/responses/compare/0.21.0...0.23.3) + +--- +updated-dependencies: +- dependency-name: responses + dependency-type: direct:production + update-type: version-update:semver-minor +... + +Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`dd6946c`](https://github.com/python-semantic-release/python-semantic-release/commit/dd6946cd479f646f3af028b92ca83db8fc4c0c66)) ### Chore @@ -436,8 +462,8 @@ Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.githu * fix: don't warn about vcs token if ignore_token_for_push is true. (#670) -* fix: don't warn about vcs token if ignore_token_for_push is true. - +* fix: don't warn about vcs token if ignore_token_for_push is true. + * docs: `password` should be `token`. ([`f1a54a6`](https://github.com/python-semantic-release/python-semantic-release/commit/f1a54a6c9a05b225b6474d50cd610eca19ec0c34)) ### Style @@ -503,184 +529,184 @@ Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.githu * feat!: v8 (#619) -* feat!: 8.0.x (#538) - -Co-authored-by: Johan <johanhmr@gmail.com> -Co-authored-by: U-NEO\johan <johan.hammar@ombea.com> - -* fix: correct Dockerfile CLI command and GHA fetch - -* fix: resolve branch checkout logic in GHA - -* fix: remove commit amending behaviour - -this was not working when there were no source code changes to be made, as it lead -to attempting to amend a HEAD commit that wasn't produced by PSR - -* 8.0.0-alpha.1 - -Automatically generated by python-semantic-release - -* fix: correct logic for generating release notes (#550) - -* fix: cleanup comments and unused logic - -* fix(action): mark container fs as safe for git to operate on - -* style: beautify 49080c510a68cccd2f6c7a8d540b483751901207 - -* fix(action): quotation for git config command - -* 8.0.0-alpha.2 - -Automatically generated by python-semantic-release - -* fix: resolve bug in changelog logic, enable upload to pypi - -* 8.0.0-alpha.3 - -Automatically generated by python-semantic-release - -* test: add tests for ReleaseHistory.release - -* fix: resolve loss of tag_format configuration - -* 8.0.0-alpha.4 - -Automatically generated by python-semantic-release - -* feat: various improvements - -* Added sorting to test parameterisation, so that pytest-xdist works again - dramatic speedup for testing -* Reworked the CI verification code so it's a bit prettier -* Added more testing for the version CLI command, and split some logic out of the command itself -* Removed a redundant double-regex match in VersionTranslator and Version, for some speedup - -* chore(test): proper env patching for tests in CI - -* style: beautify bcb27a4a8ce4789d083226f088c1810f45cd4c77 - -* refactor!: remove verify-ci command - -* 8.0.0-alpha.5 - -Automatically generated by python-semantic-release - -* fix(docs): fixup docs and remove reference to dist publication - -* feat!: remove publication of dists to artefact repository - -* feat: rename 'upload' configuration section to 'publish' - -* feat!: removed build status checking - -* feat: add GitHub Actions output - -* fix(action): remove default for 'force' - -* fix(ci): different workflow for v8 - -* fix(action): correct input parsing - -* fix: correct handling of build commands - -* feat: make it easier to access commit messages in ParsedCommits - -* fix: make additional attributes available for template authors - -* fix: add logging for token auth, use token for push - -* ci: add verbosity - -* fix: caching for repo owner and name - -* ci: contents permission for workflow - -* 8.0.0-alpha.6 - -Automatically generated by python-semantic-release - -* docs: update docs with additional required permissions - -* feat: add option to specify tag to publish to in publish command - -* feat: add Strict Mode - -* docs: convert to Furo theme - -* feat: add --skip-build option - -* 8.0.0-alpha.7 - -Automatically generated by python-semantic-release - -* test: separate command line tests by stdout and stderr - -* ci: pass tag output and conditionally execute publish steps - -* fix: correct assets type in configuration (#603) - -* change raw config assets type - -* fix: correct assets type-annotation for RuntimeContext - ---------- - -Co-authored-by: Bernard Cooke <bernard-cooke@hotmail.com> - -* 8.0.0-alpha.8 - -Automatically generated by python-semantic-release - -* fix: pin Debian version in Dockerfile - -* feat: promote to rc - -* 8.0.0-rc.1 - -Automatically generated by python-semantic-release - -* ci: fix conditionals in workflow and update documentation - -* ci: correct conditionals - -* fix: only call Github Action output callback once defaults are set - -* 8.0.0-rc.2 - -Automatically generated by python-semantic-release - -* fix: create_or_update_release for Gitlab hvcs - -* ci: remove separate v8 workflow - -* chore: tweak issue templates - -* chore: bump docs dependencies - -* 8.0.0-rc.3 - -Automatically generated by python-semantic-release - -* fix(deps): add types-click, and downgrade sphinx/furo for 3.7 - -* 8.0.0-rc.4 - -Automatically generated by python-semantic-release - -* docs: fix typo (#623) - -* docs: correct typo in docs/changelog_templates.rst - -Co-authored-by: Micael Jarniac <micael@jarniac.com> - ---------- - -Co-authored-by: Johan <johanhmr@gmail.com> -Co-authored-by: U-NEO\johan <johan.hammar@ombea.com> -Co-authored-by: semantic-release <semantic-release> -Co-authored-by: github-actions <action@github.com> -Co-authored-by: smeng9 <38666763+smeng9@users.noreply.github.com> +* feat!: 8.0.x (#538) + +Co-authored-by: Johan <johanhmr@gmail.com> +Co-authored-by: U-NEO\johan <johan.hammar@ombea.com> + +* fix: correct Dockerfile CLI command and GHA fetch + +* fix: resolve branch checkout logic in GHA + +* fix: remove commit amending behaviour + +this was not working when there were no source code changes to be made, as it lead +to attempting to amend a HEAD commit that wasn't produced by PSR + +* 8.0.0-alpha.1 + +Automatically generated by python-semantic-release + +* fix: correct logic for generating release notes (#550) + +* fix: cleanup comments and unused logic + +* fix(action): mark container fs as safe for git to operate on + +* style: beautify 49080c510a68cccd2f6c7a8d540b483751901207 + +* fix(action): quotation for git config command + +* 8.0.0-alpha.2 + +Automatically generated by python-semantic-release + +* fix: resolve bug in changelog logic, enable upload to pypi + +* 8.0.0-alpha.3 + +Automatically generated by python-semantic-release + +* test: add tests for ReleaseHistory.release + +* fix: resolve loss of tag_format configuration + +* 8.0.0-alpha.4 + +Automatically generated by python-semantic-release + +* feat: various improvements + +* Added sorting to test parameterisation, so that pytest-xdist works again - dramatic speedup for testing +* Reworked the CI verification code so it's a bit prettier +* Added more testing for the version CLI command, and split some logic out of the command itself +* Removed a redundant double-regex match in VersionTranslator and Version, for some speedup + +* chore(test): proper env patching for tests in CI + +* style: beautify bcb27a4a8ce4789d083226f088c1810f45cd4c77 + +* refactor!: remove verify-ci command + +* 8.0.0-alpha.5 + +Automatically generated by python-semantic-release + +* fix(docs): fixup docs and remove reference to dist publication + +* feat!: remove publication of dists to artefact repository + +* feat: rename 'upload' configuration section to 'publish' + +* feat!: removed build status checking + +* feat: add GitHub Actions output + +* fix(action): remove default for 'force' + +* fix(ci): different workflow for v8 + +* fix(action): correct input parsing + +* fix: correct handling of build commands + +* feat: make it easier to access commit messages in ParsedCommits + +* fix: make additional attributes available for template authors + +* fix: add logging for token auth, use token for push + +* ci: add verbosity + +* fix: caching for repo owner and name + +* ci: contents permission for workflow + +* 8.0.0-alpha.6 + +Automatically generated by python-semantic-release + +* docs: update docs with additional required permissions + +* feat: add option to specify tag to publish to in publish command + +* feat: add Strict Mode + +* docs: convert to Furo theme + +* feat: add --skip-build option + +* 8.0.0-alpha.7 + +Automatically generated by python-semantic-release + +* test: separate command line tests by stdout and stderr + +* ci: pass tag output and conditionally execute publish steps + +* fix: correct assets type in configuration (#603) + +* change raw config assets type + +* fix: correct assets type-annotation for RuntimeContext + +--------- + +Co-authored-by: Bernard Cooke <bernard-cooke@hotmail.com> + +* 8.0.0-alpha.8 + +Automatically generated by python-semantic-release + +* fix: pin Debian version in Dockerfile + +* feat: promote to rc + +* 8.0.0-rc.1 + +Automatically generated by python-semantic-release + +* ci: fix conditionals in workflow and update documentation + +* ci: correct conditionals + +* fix: only call Github Action output callback once defaults are set + +* 8.0.0-rc.2 + +Automatically generated by python-semantic-release + +* fix: create_or_update_release for Gitlab hvcs + +* ci: remove separate v8 workflow + +* chore: tweak issue templates + +* chore: bump docs dependencies + +* 8.0.0-rc.3 + +Automatically generated by python-semantic-release + +* fix(deps): add types-click, and downgrade sphinx/furo for 3.7 + +* 8.0.0-rc.4 + +Automatically generated by python-semantic-release + +* docs: fix typo (#623) + +* docs: correct typo in docs/changelog_templates.rst + +Co-authored-by: Micael Jarniac <micael@jarniac.com> + +--------- + +Co-authored-by: Johan <johanhmr@gmail.com> +Co-authored-by: U-NEO\johan <johan.hammar@ombea.com> +Co-authored-by: semantic-release <semantic-release> +Co-authored-by: github-actions <action@github.com> +Co-authored-by: smeng9 <38666763+smeng9@users.noreply.github.com> Co-authored-by: Micael Jarniac <micael@jarniac.com> ([`ec30564`](https://github.com/python-semantic-release/python-semantic-release/commit/ec30564b4ec732c001d76d3c09ba033066d2b6fe)) @@ -704,11 +730,11 @@ Co-authored-by: Micael Jarniac <micael@jarniac.com> ([`ec30564`](https://g * fix: docker build fails installing git (#605) -git was installed from bullseye-backports, but base image is referencing latest python:3.10 -since bookworm was recently released, this now points at bookworm and installing the backport of git is actually trying to downgrade, resulting in this error: - -> E: Packages were downgraded and -y was used without --allow-downgrades. - +git was installed from bullseye-backports, but base image is referencing latest python:3.10 +since bookworm was recently released, this now points at bookworm and installing the backport of git is actually trying to downgrade, resulting in this error: + +> E: Packages were downgraded and -y was used without --allow-downgrades. + > ERROR: failed to solve: process "/bin/sh -c echo \"deb http://deb.debian.org/debian bullseye-backports main\" >> /etc/apt/sources.list; apt-get update; apt-get install -y git/bullseye-backports" did not complete successfully: exit code: 100 ([`9e3eb97`](https://github.com/python-semantic-release/python-semantic-release/commit/9e3eb979783bc39ca564c2967c6c77eecba682e6)) @@ -734,7 +760,7 @@ In #594, I missed that there are 2 places where the version header is formatted * fix: generate markdown linter compliant changelog headers & lists (#594) -Add an extra new line after each header and between sections to fix 2 markdownlint errors +Add an extra new line after each header and between sections to fix 2 markdownlint errors for changelogs generated by this package ([`9d9d403`](https://github.com/python-semantic-release/python-semantic-release/commit/9d9d40305c499c907335abe313e3ed122db0b154)) ### Style @@ -748,9 +774,9 @@ for changelogs generated by this package ([`9d9d403`](https://github.com/python- * feat: add option to only parse commits for current working directory (#509) -When running the application from a sub-directory in the VCS, the option -use_only_cwd_commits will filter out commits that does not changes the -current working directory, similar to running commands like +When running the application from a sub-directory in the VCS, the option +use_only_cwd_commits will filter out commits that does not changes the +current working directory, similar to running commands like `git log -- .` in a sub-directory. ([`cdf8116`](https://github.com/python-semantic-release/python-semantic-release/commit/cdf8116c1e415363b10a01f541873e04ad874220)) @@ -760,22 +786,22 @@ current working directory, similar to running commands like * docs: update broken badge and add links (#591) -The "Test Status" badge was updated to address a recent breaking change in the -GitHub actions API. All the badges updated to add links to the appropriate +The "Test Status" badge was updated to address a recent breaking change in the +GitHub actions API. All the badges updated to add links to the appropriate resources for end-user convenience. ([`0c23447`](https://github.com/python-semantic-release/python-semantic-release/commit/0c234475d27ad887b19170c82deb80293b3a95f1)) ### Fix * fix: update docs and default config for gitmoji changes (#590) -* fix: update docs and default config for gitmoji changes - -PR #582 updated to the latest Gitmojis release however the documentation and -default config options still referenced old and unsupported Gitmojis. - -* fix: update sphinx dep - -I could only build the documentation locally by updating Sphinx to the latest +* fix: update docs and default config for gitmoji changes + +PR #582 updated to the latest Gitmojis release however the documentation and +default config options still referenced old and unsupported Gitmojis. + +* fix: update sphinx dep + +I could only build the documentation locally by updating Sphinx to the latest 1.x version. ([`192da6e`](https://github.com/python-semantic-release/python-semantic-release/commit/192da6e1352298b48630423d50191070a1c5ab24)) @@ -802,16 +828,16 @@ In order to avoid 'Repository not found: relekang/python-semantic-release.&# * docs: spelling and grammar in `travis.rst` (#556) -- spelling -- subject-verb agreement -- remove verbiage - +- spelling +- subject-verb agreement +- remove verbiage + Signed-off-by: Vladislav Doster <mvdoster@gmail.com> ([`3a76e9d`](https://github.com/python-semantic-release/python-semantic-release/commit/3a76e9d7505c421009eb3e953c32cccac2e70e07)) * docs: grammar in `docs/troubleshooting.rst` (#557) -- change contraction to a possessive pronoun - +- change contraction to a possessive pronoun + Signed-off-by: Vladislav Doster <mvdoster@gmail.com> ([`bbe754a`](https://github.com/python-semantic-release/python-semantic-release/commit/bbe754a3db9ce7132749e7902fe118b52f48ee42)) ### Fix @@ -859,11 +885,11 @@ It is spamming to much. We can bring it back if we get the time to fix the spamm * ci: remove python3.6 from GHA, add python3.10 and python3.11 (#541) -* ci: remove python3.6 from GHA, add python3.10 and python3.11 - -GHA workflows are failing without this, due to -https://github.com/actions/setup-python/issues/544\#issuecomment-1332535877 - +* ci: remove python3.6 from GHA, add python3.10 and python3.11 + +GHA workflows are failing without this, due to +https://github.com/actions/setup-python/issues/544\#issuecomment-1332535877 + * fix: upgrade pytest ([`8e4aa0e`](https://github.com/python-semantic-release/python-semantic-release/commit/8e4aa0e30438291ade98604a18aeb372f0d0b52f)) ### Feature @@ -882,17 +908,17 @@ Co-authored-by: Kevin Watson <Kevmo92@users.noreply.github.com> ([`4664afe * fix: changelog release commit search logic (#530) -* Fixes changelog release commit search logic - -Running `semantic-release changelog` currently fails to identify "the last commit in [a] release" because the compared commit messages have superfluous whitespace. -Likely related to the issue causing: https://github.com/relekang/python-semantic-release/issues/490 - +* Fixes changelog release commit search logic + +Running `semantic-release changelog` currently fails to identify "the last commit in [a] release" because the compared commit messages have superfluous whitespace. +Likely related to the issue causing: https://github.com/relekang/python-semantic-release/issues/490 + * Removes a couple of extra `strip()`s. ([`efb3410`](https://github.com/python-semantic-release/python-semantic-release/commit/efb341036196c39b4694ca4bfa56c6b3e0827c6c)) * fix: bump Dockerfile to use Python 3.10 image (#536) -Fixes #533 - +Fixes #533 + Co-authored-by: Bernard Cooke <bernard.cooke@iotics.com> ([`8f2185d`](https://github.com/python-semantic-release/python-semantic-release/commit/8f2185d570b3966b667ac591ae523812e9d2e00f)) * fix: fix mypy errors for publish ([`b40dd48`](https://github.com/python-semantic-release/python-semantic-release/commit/b40dd484387c1b3f78df53ee2d35e281e8e799c8)) @@ -918,10 +944,10 @@ Co-authored-by: Bernard Cooke <bernard.cooke@iotics.com> ([`8f2185d`](http * ci: Update deprecated actions (#511) -* ci: update depreated actions - -* ci: replace deprecated set-output in workflow - +* ci: update depreated actions + +* ci: replace deprecated set-output in workflow + According to https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ ([`bb09233`](https://github.com/python-semantic-release/python-semantic-release/commit/bb09233b84d153a15784fdf68d7274c9d682c336)) ### Documentation @@ -1092,9 +1118,9 @@ Fixes #473 ([`0ece6f2`](https://github.com/python-semantic-release/python-semant * fix: allow changing prerelease tag using CLI flags (#466) -Delay construction of version and release patterns until runtime. -This will allow to use non-default prerelease tag. - +Delay construction of version and release patterns until runtime. +This will allow to use non-default prerelease tag. + Co-authored-by: Dzmitry Ryzhykau <d.ryzhykau@onesoil.ai> ([`395bf4f`](https://github.com/python-semantic-release/python-semantic-release/commit/395bf4f2de73663c070f37cced85162d41934213)) @@ -1104,8 +1130,8 @@ Co-authored-by: Dzmitry Ryzhykau <d.ryzhykau@onesoil.ai> ([`395bf4f`](http * fix(publish): get version bump for current release (#467) -Replicate the behavior of "version" command in version calculation. - +Replicate the behavior of "version" command in version calculation. + Co-authored-by: Dzmitry Ryzhykau <d.ryzhykau@onesoil.ai> ([`dd26888`](https://github.com/python-semantic-release/python-semantic-release/commit/dd26888a923b2f480303c19f1916647de48b02bf)) * fix: add packaging module requirement (#469) ([`b99c9fa`](https://github.com/python-semantic-release/python-semantic-release/commit/b99c9fa88dc25e5ceacb131cd93d9079c4fb2c86)) @@ -1179,33 +1205,33 @@ Co-authored-by: Sebastian Seith <sebastian@vermill.io> ([`da0606f`](https: * ci: adjust actions test phase to use fetch-depth: 0 to fix ci tests (#446) -Co-authored-by: Sebastian Seith <sebastian@vermill.io> +Co-authored-by: Sebastian Seith <sebastian@vermill.io> Co-authored-by: github-actions <action@github.com> ([`3329eef`](https://github.com/python-semantic-release/python-semantic-release/commit/3329eeffb077f628e4a965bc7fd922d09d6b63da)) ### Feature * feat: allow using ssh-key to push version while using token to publish to hvcs (#419) -* feat(config): add ignore_token_for_push param - -Add ignore_token_for_push parameter that allows using the underlying -git authentication mechanism for pushing a new version commit and tags -while also using an specified token to upload dists - -* test(config): add test for ignore_token_for_push - -Test push_new_version with token while ignore_token_for_push is True -and False - -* docs: add documentation for ignore_token_for_push - -* fix(test): override GITHUB_ACTOR env - -push_new_version is using GITHUB_ACTOR env var but we did not -contemplate in our new tests that actually Github actions running the -tests will populate that var and change the test outcome - -Now we control the value of that env var and test for it being present +* feat(config): add ignore_token_for_push param + +Add ignore_token_for_push parameter that allows using the underlying +git authentication mechanism for pushing a new version commit and tags +while also using an specified token to upload dists + +* test(config): add test for ignore_token_for_push + +Test push_new_version with token while ignore_token_for_push is True +and False + +* docs: add documentation for ignore_token_for_push + +* fix(test): override GITHUB_ACTOR env + +push_new_version is using GITHUB_ACTOR env var but we did not +contemplate in our new tests that actually Github actions running the +tests will populate that var and change the test outcome + +Now we control the value of that env var and test for it being present or not ([`7b2dffa`](https://github.com/python-semantic-release/python-semantic-release/commit/7b2dffadf43c77d5e0eea307aefcee5c7744df5c)) ### Fix @@ -1243,16 +1269,16 @@ Fixes #354 ([`cf74339`](https://github.com/python-semantic-release/python-semant * chore(dependencies): unpin tomlkit dependency (#429) -- tests for a tomlkit regression don't fail anymore with newer tomlkit -- keep comment in setup.py about tomlkit being pinned at some point in time - +- tests for a tomlkit regression don't fail anymore with newer tomlkit +- keep comment in setup.py about tomlkit being pinned at some point in time + refs #336 ([`8515879`](https://github.com/python-semantic-release/python-semantic-release/commit/85158798ca438c1dafc84036d13c2988c934f02f)) ### Fix * fix(prerelase): pass prerelease option to get_current_version (#432) -The `get_current_version` function accepts a `prerelease` argument which +The `get_current_version` function accepts a `prerelease` argument which was never passed. ([`aabab0b`](https://github.com/python-semantic-release/python-semantic-release/commit/aabab0b7ce647d25e0c78ae6566f1132ece9fcb9)) ### Style @@ -1266,7 +1292,7 @@ was never passed. ([`aabab0b`](https://github.com/python-semantic-release/python * chore(dependencies): extend allowed version range for python-gitlab (#417) -* chore(dependencies): extend allowed version range for python-gitlab +* chore(dependencies): extend allowed version range for python-gitlab * fix(type): ignore mypy errors for dynamic RESTObject ([`8ee4d4b`](https://github.com/python-semantic-release/python-semantic-release/commit/8ee4d4b8dabfa5c6cd2aa6180d4a8da8f3c9554c)) ### Feature @@ -1280,18 +1306,18 @@ was never passed. ([`aabab0b`](https://github.com/python-semantic-release/python * feat: add prerelease functionality (#413) -* chore: add initial todos -* feat: add prerelease tag option -* feat: add prerelease cli flag -* feat: omit_pattern for previouse and current version getters -* feat: print_version with prerelease bump -* feat: make print_version prerelease ready -* feat: move prerelease determination to get_new_version -* test: improve get_last_version test -* docs: added basic infos about prereleases -* feat: add prerelease flag to version and publish -* feat: remove leftover todos - +* chore: add initial todos +* feat: add prerelease tag option +* feat: add prerelease cli flag +* feat: omit_pattern for previouse and current version getters +* feat: print_version with prerelease bump +* feat: make print_version prerelease ready +* feat: move prerelease determination to get_new_version +* test: improve get_last_version test +* docs: added basic infos about prereleases +* feat: add prerelease flag to version and publish +* feat: remove leftover todos + Co-authored-by: Mario Jäckle <m.jaeckle@careerpartner.eu> ([`7064265`](https://github.com/python-semantic-release/python-semantic-release/commit/7064265627a2aba09caa2873d823b594e0e23e77)) ### Style @@ -1312,7 +1338,7 @@ Co-authored-by: Mario Jäckle <m.jaeckle@careerpartner.eu> ([`7064265`](ht * fix(gitea): build status and asset upload (#420) -* fix(gitea): handle list build status response +* fix(gitea): handle list build status response * fix(gitea): use form-data for upload_asset ([`57db81f`](https://github.com/python-semantic-release/python-semantic-release/commit/57db81f4c6b96da8259e3bad9137eaccbcd10f6e)) ### Style @@ -1444,10 +1470,10 @@ executable. No-op mode now respected by artifact upload. ([`cfb20af`](https://gi * feat: allow custom environment variable names (#392) -* GH_TOKEN can now be customized by setting github_token_var -* GL_TOKEN can now be customized by setting gitlab_token_var -* PYPI_PASSWORD can now be customized by setting pypi_pass_var -* PYPI_TOKEN can now be customized by setting pypi_token_var +* GH_TOKEN can now be customized by setting github_token_var +* GL_TOKEN can now be customized by setting gitlab_token_var +* PYPI_PASSWORD can now be customized by setting pypi_pass_var +* PYPI_TOKEN can now be customized by setting pypi_token_var * PYPI_USERNAME can now be customized by setting pypi_user_var ([`372cda3`](https://github.com/python-semantic-release/python-semantic-release/commit/372cda3497f16ead2209e6e1377d38f497144883)) * feat: use gitlab-ci or github actions env vars @@ -1515,8 +1541,8 @@ https://github.com/relekang/python-semantic-release/issues/391#issuecomment-9506 * feat: custom git tag format support (#373) -* feat: custom git tag format support -* test: add git tag format check +* feat: custom git tag format support +* test: add git tag format check * docs: add tag_format config option ([`1d76632`](https://github.com/python-semantic-release/python-semantic-release/commit/1d76632043bf0b6076d214a63c92013624f4b95e)) @@ -1562,9 +1588,9 @@ Co-authored-by: Laercio Barbosa <laercio.barbosa@scania.com> ([`a275a7a`]( * chore: bump responses to latest version (#343) -The current version has a Deprecation warning: - -inspect.getargspec() is deprecated since Python 3.0, +The current version has a Deprecation warning: + +inspect.getargspec() is deprecated since Python 3.0, use inspect.signature() or inspect.getfullargspec() ([`e953157`](https://github.com/python-semantic-release/python-semantic-release/commit/e953157125f4528759453218f75b6e51cafd2cc3)) ### Ci @@ -1747,23 +1773,23 @@ Fixes #329 ([`abfacc4`](https://github.com/python-semantic-release/python-semant * docs: correct casing on proper nouns (#320) -* docs: correcting Semantic Versioning casing - -Semantic Versioning is the name of the specification. -Therefore it is a proper noun. -This patch corrects the incorrect casing for Semantic Versioning. - -* docs: correcting Python casing - +* docs: correcting Semantic Versioning casing + +Semantic Versioning is the name of the specification. +Therefore it is a proper noun. +This patch corrects the incorrect casing for Semantic Versioning. + +* docs: correcting Python casing + This patch corrects the incorrect casing for Python. ([`d51b999`](https://github.com/python-semantic-release/python-semantic-release/commit/d51b999a245a4e56ff7a09d0495c75336f2f150d)) ### Feature * feat(checks): add support for Jenkins CI (#322) -Includes a ci check handler to verify jenkins. -Unlike other ci systems jenkins doesn't generally prefix things with -`JENKINS` or simply inject `JENKINS=true` Really the only thing that is +Includes a ci check handler to verify jenkins. +Unlike other ci systems jenkins doesn't generally prefix things with +`JENKINS` or simply inject `JENKINS=true` Really the only thing that is immediately identifiable is `JENKINS_URL` ([`3e99855`](https://github.com/python-semantic-release/python-semantic-release/commit/3e99855c6bc72b3e9a572c58cc14e82ddeebfff8)) ### Style @@ -1781,10 +1807,10 @@ immediately identifiable is `JENKINS_URL` ([`3e99855`](https://github.com/python * fix: fix crash when TOML has no PSR section (#319) -* test: reproduce issue with TOML without PSR section - -* fix: crash when TOML has no PSR section - +* test: reproduce issue with TOML without PSR section + +* fix: crash when TOML has no PSR section + * chore: remove unused imports ([`5f8ab99`](https://github.com/python-semantic-release/python-semantic-release/commit/5f8ab99bf7254508f4b38fcddef2bdde8dd15a4c)) @@ -1807,26 +1833,26 @@ Fixes #306 ([`1a85af4`](https://github.com/python-semantic-release/python-semant * feat: support toml files for version declaration (#307) -This introduce a new `version_toml` configuration property that behaves -like `version_pattern` and `version_variable`. - -For poetry support, user should now set `version_toml = pyproject.toml:tool.poetry.version`. - -This introduce an ABC class, `VersionDeclaration`, that -can be implemented to add other version declarations with ease. - -`toml` dependency has been replaced by `tomlkit`, as this is used -the library used by poetry to generate the `pyproject.toml` file, and -is able to keep the ordering of data defined in the file. - -Existing `VersionPattern` class has been renamed to -`PatternVersionDeclaration` and now implements `VersionDeclaration`. - -`load_version_patterns()` function has been renamed to -`load_version_declarations()` and now return a list of -`VersionDeclaration` implementations. - -Close #245 +This introduce a new `version_toml` configuration property that behaves +like `version_pattern` and `version_variable`. + +For poetry support, user should now set `version_toml = pyproject.toml:tool.poetry.version`. + +This introduce an ABC class, `VersionDeclaration`, that +can be implemented to add other version declarations with ease. + +`toml` dependency has been replaced by `tomlkit`, as this is used +the library used by poetry to generate the `pyproject.toml` file, and +is able to keep the ordering of data defined in the file. + +Existing `VersionPattern` class has been renamed to +`PatternVersionDeclaration` and now implements `VersionDeclaration`. + +`load_version_patterns()` function has been renamed to +`load_version_declarations()` and now return a list of +`VersionDeclaration` implementations. + +Close #245 Close #275 ([`9b62a7e`](https://github.com/python-semantic-release/python-semantic-release/commit/9b62a7e377378667e716384684a47cdf392093fa)) ### Style @@ -1846,8 +1872,8 @@ Fixes #311 ([`e2d8e47`](https://github.com/python-semantic-release/python-semant * feat(github): retry GitHub API requests on failure (#314) -* refactor(github): use requests.Session to call raise_for_status - +* refactor(github): use requests.Session to call raise_for_status + * fix(github): add retries to github API requests ([`ac241ed`](https://github.com/python-semantic-release/python-semantic-release/commit/ac241edf4de39f4fc0ff561a749fa85caaf9e2ae)) ### Style @@ -1941,10 +1967,10 @@ Fixes: #277 ([`ab3061a`](https://github.com/python-semantic-release/python-seman * fix(history): coerce version to string (#298) -The changes in #297 mistakenly omitted coercing the return value to a -string. This resulted in errors like: -"can only concatenate str (not "VersionInfo") to str" - +The changes in #297 mistakenly omitted coercing the return value to a +string. This resulted in errors like: +"can only concatenate str (not "VersionInfo") to str" + Add test case asserting it's type str ([`d4cdc3d`](https://github.com/python-semantic-release/python-semantic-release/commit/d4cdc3d3cd2d93f2a78f485e3ea107ac816c7d00)) * fix(history): require semver >= 2.10 @@ -2020,8 +2046,8 @@ the end of a PR that is merged via rebase merge or merge commit. ([`93e48c9`](ht * feat(changelog): add PR links in markdown (#282) -GitHub release notes automagically link to the PR, but changelog -markdown doesn't. Replace a PR number at the end of a message +GitHub release notes automagically link to the PR, but changelog +markdown doesn't. Replace a PR number at the end of a message with a markdown link. ([`0448f6c`](https://github.com/python-semantic-release/python-semantic-release/commit/0448f6c350bbbf239a81fe13dc5f45761efa7673)) ### Style @@ -2045,7 +2071,7 @@ To control if bump major or not when current major version is zero. ([`d324154`] * refactor(history): move changelog_scope default (#284) -* Move the default for changelog_scope from inline to defaults.cfg. +* Move the default for changelog_scope from inline to defaults.cfg. * Add missing header in docs. ([`b7e1376`](https://github.com/python-semantic-release/python-semantic-release/commit/b7e1376ee1688e5e6dcc069ce623f49e3a389052)) ### Style @@ -2061,13 +2087,13 @@ A few settings were not in alphabetical order. ([`60a3535`](https://github.com/p * feat(logs): include scope in changelogs (#281) -When the scope is set, include it in changelogs, e.g. -"feat(x): some description" becomes "**x**: some description". -This is similar to how the Node semantic release (and -conventional-changelog-generator) generates changelogs. -If scope is not given, it's omitted. - -Add a new config parameter changelog_scope to disable this behavior when +When the scope is set, include it in changelogs, e.g. +"feat(x): some description" becomes "**x**: some description". +This is similar to how the Node semantic release (and +conventional-changelog-generator) generates changelogs. +If scope is not given, it's omitted. + +Add a new config parameter changelog_scope to disable this behavior when set to 'False' ([`21c96b6`](https://github.com/python-semantic-release/python-semantic-release/commit/21c96b688cc44cc6f45af962ffe6d1f759783f37)) ### Style @@ -2113,11 +2139,11 @@ Fixes #260 ([`7cacca1`](https://github.com/python-semantic-release/python-semant * ci: check commit logs with commitlint (#263) -The contributing guide says that the project should itself follow the -Angular commit convention, but there is nothing to enforce it AFAIK. - -I had a similar problem on a project where I'm using -`python-semantic-release` and I've added a Github action to +The contributing guide says that the project should itself follow the +Angular commit convention, but there is nothing to enforce it AFAIK. + +I had a similar problem on a project where I'm using +`python-semantic-release` and I've added a Github action to test it on CI, you might find it useful too. ([`016fde6`](https://github.com/python-semantic-release/python-semantic-release/commit/016fde683924d380d25579bd0cff0c7f8b7b2240)) ### Documentation @@ -2142,7 +2168,7 @@ the method above. ([`5a5e2cf`](https://github.com/python-semantic-release/python * fix: add required to inputs in action metadata (#264) -According to the documentation, `inputs.<input_id>.required` is a +According to the documentation, `inputs.<input_id>.required` is a required field. ([`e76b255`](https://github.com/python-semantic-release/python-semantic-release/commit/e76b255cf7d3d156e3314fc28c54d63fa126e973)) @@ -2199,8 +2225,8 @@ Fixes #250 ([`87e2bb8`](https://github.com/python-semantic-release/python-semant * docs: give example of multiple build commands (#248) -I had a little trouble figuring out how to use a non-setup.py build -command, so I thought it would be helpful to update the docs with an +I had a little trouble figuring out how to use a non-setup.py build +command, so I thought it would be helpful to update the docs with an example of how to do this. ([`65f1ffc`](https://github.com/python-semantic-release/python-semantic-release/commit/65f1ffcc6cac3bf382f4b821ff2be59d04f9f867)) ### Fix @@ -2218,13 +2244,13 @@ example of how to do this. ([`65f1ffc`](https://github.com/python-semantic-relea * feat: bump versions in multiple files (#246) -- Add the `version_pattern` setting, which allows version numbers to be - identified using arbitrary regular expressions. -- Refactor the config system to allow non-string data types to be - specified in `pyproject.toml`. -- Multiple files can now be specified by setting `version_variable` or - `version_pattern` to a list in `pyproject.toml`. - +- Add the `version_pattern` setting, which allows version numbers to be + identified using arbitrary regular expressions. +- Refactor the config system to allow non-string data types to be + specified in `pyproject.toml`. +- Multiple files can now be specified by setting `version_variable` or + `version_pattern` to a list in `pyproject.toml`. + Fixes #175 ([`0ba2c47`](https://github.com/python-semantic-release/python-semantic-release/commit/0ba2c473c6e44cc326b3299b6ea3ddde833bdb37)) ### Style @@ -2245,9 +2271,9 @@ Fixes #175 ([`0ba2c47`](https://github.com/python-semantic-release/python-semant * feat(changelog): add changelog_table component (#242) -Add an alternative changelog component which displays each section as a -row in a table. - +Add an alternative changelog component which displays each section as a +row in a table. + Fixes #237 ([`fe6a7e7`](https://github.com/python-semantic-release/python-semantic-release/commit/fe6a7e7fa014ffb827a1430dbcc10d1fc84c886b)) ### Style @@ -2265,25 +2291,25 @@ Fixes #237 ([`fe6a7e7`](https://github.com/python-semantic-release/python-semant * feat(changelog): add changelog components (#240) -* feat(changelog): add changelog components - -Add the ability to configure sections of the changelog using a -`changelog_components` option. Component outputs are separated by a blank -line and appear in the same order as they were configured. - -It is possible to create your own custom components. Each component is a -function which returns either some text to be added, or None in which case it -will be skipped. - -BREAKING CHANGE: The `compare_url` option has been removed in favor of using -`changelog_components`. This functionality is now available as the -`semantic_release.changelog.compare_url` component. - -* docs: add documentation for changelog_components - -* feat: pass changelog_sections to components - -Changelog components may now receive the value of `changelog_sections`, +* feat(changelog): add changelog components + +Add the ability to configure sections of the changelog using a +`changelog_components` option. Component outputs are separated by a blank +line and appear in the same order as they were configured. + +It is possible to create your own custom components. Each component is a +function which returns either some text to be added, or None in which case it +will be skipped. + +BREAKING CHANGE: The `compare_url` option has been removed in favor of using +`changelog_components`. This functionality is now available as the +`semantic_release.changelog.compare_url` component. + +* docs: add documentation for changelog_components + +* feat: pass changelog_sections to components + +Changelog components may now receive the value of `changelog_sections`, split and ready to use. ([`3e17a98`](https://github.com/python-semantic-release/python-semantic-release/commit/3e17a98d7fa8468868a87e62651ac2c010067711)) ### Style @@ -2310,30 +2336,30 @@ Fixes #239 ([`34acbbc`](https://github.com/python-semantic-release/python-semant * feat(history): create emoji parser (#238) -Add a commit parser which uses emojis from https://gitmoji.carloscuesta.me/ -to determine the type of change. - -* fix: add emojis to default changelog_sections - -* fix: include all parsed types in changelog - -This allows emojis to appear in the changelog, as well as configuring -other types to appear with the Angular parser (I remember someone asking -for that feature a while ago). All filtering is now done in the -markdown_changelog function. - -* refactor(history): get breaking changes in parser - -Move the task of detecting breaking change descriptions into the commit -parser function, instead of during changelog generation. - -This has allowed the emoji parser to also return the regular descriptions as -breaking change descriptions for commits with :boom:. - -BREAKING CHANGE: Custom commit parser functions are now required to pass -a fifth argument to `ParsedCommit`, which is a list of breaking change -descriptions. - +Add a commit parser which uses emojis from https://gitmoji.carloscuesta.me/ +to determine the type of change. + +* fix: add emojis to default changelog_sections + +* fix: include all parsed types in changelog + +This allows emojis to appear in the changelog, as well as configuring +other types to appear with the Angular parser (I remember someone asking +for that feature a while ago). All filtering is now done in the +markdown_changelog function. + +* refactor(history): get breaking changes in parser + +Move the task of detecting breaking change descriptions into the commit +parser function, instead of during changelog generation. + +This has allowed the emoji parser to also return the regular descriptions as +breaking change descriptions for commits with :boom:. + +BREAKING CHANGE: Custom commit parser functions are now required to pass +a fifth argument to `ParsedCommit`, which is a list of breaking change +descriptions. + * docs: add documentation for emoji parser ([`2e1c50a`](https://github.com/python-semantic-release/python-semantic-release/commit/2e1c50a865628b372f48945a039a3edb38a7cdf0)) ### Style @@ -2407,12 +2433,12 @@ Any issues which are labelled as a question will be closed after two weeks of in * ci: pass SHA from beautify to release -Checkout the current SHA from the end of the beautify job for releasing, -instead of master. This will either be the same as the commit we are -running for, or the SHA of a style commit. This prevents releasing of +Checkout the current SHA from the end of the beautify job for releasing, +instead of master. This will either be the same as the commit we are +running for, or the SHA of a style commit. This prevents releasing of untested code. -See +See https://github.community/t5/GitHub-Actions/Checkout-commit-pushed-by-previous-job/m-p/55847#M9670 ([`76e34b6`](https://github.com/python-semantic-release/python-semantic-release/commit/76e34b6b52b8019e87eaddf295d0781b6aa51541)) ### Documentation @@ -2490,15 +2516,15 @@ This was missed in 213530fb0c914e274b81d1dacf38ea7322b5b91f ([`3084249`](https:/ * refactor(debug): use logging and click_log instead of ndebug -BREAKING CHANGE: `DEBUG="*"` no longer has an effect, instead use +BREAKING CHANGE: `DEBUG="*"` no longer has an effect, instead use `--verbosity DEBUG`. ([`15b1f65`](https://github.com/python-semantic-release/python-semantic-release/commit/15b1f650f29761e1ab2a91b767cbff79b2057a4c)) ### Build * build(pip): store requirements in setup.py -Remove the requirements directory and instead store all required -libraries directly inside setup.py. Development, testing and docs +Remove the requirements directory and instead store all required +libraries directly inside setup.py. Development, testing and docs dependencies are included as extras. ([`401468f`](https://github.com/python-semantic-release/python-semantic-release/commit/401468f312cf4f3b52006c68c58c4645b5e19802)) ### Chore @@ -2511,12 +2537,12 @@ Allow mypy and coverage to run on any Python version. ([`28feba6`](https://githu * ci: always checkout most recent commit to release -This should pull a beautify commit if one has been created, allowing the +This should pull a beautify commit if one has been created, allowing the new version to be pushed. ([`6c98aab`](https://github.com/python-semantic-release/python-semantic-release/commit/6c98aab932724e3aab08e68b75439bc8c31bd877)) * ci: cache testing dependencies -This should help improve the speed of the testing workflow by caching +This should help improve the speed of the testing workflow by caching downloaded dependencies. ([`4f53e35`](https://github.com/python-semantic-release/python-semantic-release/commit/4f53e351960a6b658f50265384c9e8f678718f68)) * ci: move beautification to separate workflow @@ -2533,7 +2559,7 @@ Run isort and Black on pushes to master. Any edits made are committed. isort and * docs: include README.rst in index.rst -These files were very similar so it makes sense to simply include one +These files were very similar so it makes sense to simply include one inside the other. ([`8673a9d`](https://github.com/python-semantic-release/python-semantic-release/commit/8673a9d92a9bf348bb3409e002a830741396c8ca)) * docs: rewrite README.rst ([`e049772`](https://github.com/python-semantic-release/python-semantic-release/commit/e049772cf14cdd49538cf357db467f0bf3fe9587)) @@ -2563,12 +2589,12 @@ inside the other. ([`8673a9d`](https://github.com/python-semantic-release/python * ci: fetch full history in release job -I didn't realise that actions/checkout@v2 only fetches 1 commit by +I didn't realise that actions/checkout@v2 only fetches 1 commit by default. ([`a02a9b7`](https://github.com/python-semantic-release/python-semantic-release/commit/a02a9b7e34d8e7f8bb3b9c8aa1b5e1ef8bdd406c)) * ci: run tests on pull_request -The tests didn't run for #211 which caused a flake8 failure to be +The tests didn't run for #211 which caused a flake8 failure to be missed. ([`32fd77e`](https://github.com/python-semantic-release/python-semantic-release/commit/32fd77ed835bcfc943abeacec4e327df045b2ec9)) * ci: run tests on GitHub Actions ([`39ff283`](https://github.com/python-semantic-release/python-semantic-release/commit/39ff283312a0c686bfc5be71e1da9b6456652d95)) @@ -2591,7 +2617,7 @@ Automatically create pages in the API docs section using sphinx-autodoc. This is * style: fix styling from 2997908 -These code style problems were introduced because tests didn't run on +These code style problems were introduced because tests didn't run on #211. ([`172391e`](https://github.com/python-semantic-release/python-semantic-release/commit/172391ec5b5e490081b9b0ea58a94dfd5be33937)) @@ -2620,31 +2646,31 @@ These code style problems were introduced because tests didn't run on * fix: Bump dependencies and fix Windows issues on Development (#173) -* Bump dependencies and fix windows issues - -* Correctly pass temp dir to test settings - -* Remove print call on test settings - -* chore: remove py34 and py35 classifiers - -* chore: bump twine, requests and python-gitlab - -* chore: update tox config to be more granular - -* fix: missing mime types on Windows - -* chore: bump circleCI and tox python to 3.8 - -* chore: remove py36 from tox envlist - +* Bump dependencies and fix windows issues + +* Correctly pass temp dir to test settings + +* Remove print call on test settings + +* chore: remove py34 and py35 classifiers + +* chore: bump twine, requests and python-gitlab + +* chore: update tox config to be more granular + +* fix: missing mime types on Windows + +* chore: bump circleCI and tox python to 3.8 + +* chore: remove py36 from tox envlist + * chore: isort errors ([`0a6f8c3`](https://github.com/python-semantic-release/python-semantic-release/commit/0a6f8c3842b05f5f424dad5ce1fa5e3823c7e688)) ### Refactor * refactor(history): use a named tuple for parsed commits -This improves readability as we can use attributes such as 'bump' and +This improves readability as we can use attributes such as 'bump' and 'descriptions' instead of confusing numeric indices. ([`bff40d5`](https://github.com/python-semantic-release/python-semantic-release/commit/bff40d53174ffe27451d82132c31b112c7bee9fd)) @@ -2683,10 +2709,10 @@ will get the version they specify. ([`123984d`](https://github.com/python-semant * feat(build): allow config setting for build command (#195) -* feat(build): allow config setting for build command - -BREAKING CHANGE: Previously the build_commands configuration variable set the types of bundles sent to `python setup.py`. It has been replaced by the configuration variable `build_command` which takes the full command e.g. `python setup.py sdist` or `poetry build`. - +* feat(build): allow config setting for build command + +BREAKING CHANGE: Previously the build_commands configuration variable set the types of bundles sent to `python setup.py`. It has been replaced by the configuration variable `build_command` which takes the full command e.g. `python setup.py sdist` or `poetry build`. + Closes #188 ([`740f4bd`](https://github.com/python-semantic-release/python-semantic-release/commit/740f4bdb26569362acfc80f7e862fc2c750a46dd)) ### Fix @@ -2784,46 +2810,46 @@ Fixes #181 ([`0fddbe2`](https://github.com/python-semantic-release/python-semant * feat: Upload distribution files to GitHub Releases (#177) -* refactor(github): create upload_asset function - -Create a function to call the asset upload API. This will soon be used -to upload assets specified by the user. - -* refactor(github): infer Content-Type from file extension - -Infer the Content-Type header based on the file extension instead of setting it manually. - -* refactor(pypi): move building of dists to cli.py - -Refactor to have the building/removal of distributions in cli.py instead -of within the upload_to_pypi function. This makes way for uploading to -other locations, such as GitHub Releases, too. - -* feat(github): upload dists to release - -Upload Python wheels to the GitHub release. Configured with the option -upload_to_release, on by default if using GitHub. - -* docs: document upload_to_release config option - -* test(github): add tests for Github.upload_dists - -* fix(github): fix upload of .whl files - -Fix uploading of .whl files due to a missing MIME type (defined custom type as application/x-wheel+zip). Additionally, continue with other uploads even if one fails. - -* refactor(cli): additional output during publish - -Add some additional output during the publish command. - -* refactor(github): move api calls to separate methods - -Move each type of GitHub API request into its own method to improve readability. - -Re-implementation of #172 - -* fix: post changelog after PyPI upload - +* refactor(github): create upload_asset function + +Create a function to call the asset upload API. This will soon be used +to upload assets specified by the user. + +* refactor(github): infer Content-Type from file extension + +Infer the Content-Type header based on the file extension instead of setting it manually. + +* refactor(pypi): move building of dists to cli.py + +Refactor to have the building/removal of distributions in cli.py instead +of within the upload_to_pypi function. This makes way for uploading to +other locations, such as GitHub Releases, too. + +* feat(github): upload dists to release + +Upload Python wheels to the GitHub release. Configured with the option +upload_to_release, on by default if using GitHub. + +* docs: document upload_to_release config option + +* test(github): add tests for Github.upload_dists + +* fix(github): fix upload of .whl files + +Fix uploading of .whl files due to a missing MIME type (defined custom type as application/x-wheel+zip). Additionally, continue with other uploads even if one fails. + +* refactor(cli): additional output during publish + +Add some additional output during the publish command. + +* refactor(github): move api calls to separate methods + +Move each type of GitHub API request into its own method to improve readability. + +Re-implementation of #172 + +* fix: post changelog after PyPI upload + Post the changelog in-between uploading to PyPI and uploading to GitHub Releases. This is so that if the PyPI upload fails, GitHub users will not be notified. GitHub uploads still need to be processed after creating the changelog as the release notes must be published to upload assets to them. ([`e427658`](https://github.com/python-semantic-release/python-semantic-release/commit/e427658e33abf518191498c3142a0f18d3150e07)) ### Fix @@ -2843,7 +2869,7 @@ application/octet-stream is more generic, but it is better than using a non-offi * feat(history): capitalize changelog messages -Capitalize the first letter of messages in the changelog regardless of +Capitalize the first letter of messages in the changelog regardless of whether they are capitalized in the commit itself. ([`1a8e306`](https://github.com/python-semantic-release/python-semantic-release/commit/1a8e3060b8f6d6362c27903dcfc69d17db5f1d36)) ### Fix @@ -2881,7 +2907,7 @@ Fix the syntax of a broken bullet-point list in README.rst. ([`7aa572b`](https:/ * fix(github): send token in request header -Use an Authorization header instead of deprecated query parameter +Use an Authorization header instead of deprecated query parameter authorization. Fixes relekang/python-semantic-release#167 ([`be9972a`](https://github.com/python-semantic-release/python-semantic-release/commit/be9972a7b1fb183f738fb31bd370adb30281e4d5)) @@ -2952,13 +2978,13 @@ Fixes #156 ([`a4f8a10`](https://github.com/python-semantic-release/python-semant * fix: fallback to whole log if correct tag is not available (#157) -The method getting all commits to consider for the release will now test -whether the version in input is a valid reference. If it is not, it will -consider the whole log for the repository. - -evaluate_version_bump will still consider a message starting with the -version number as a breaking condition to stop analyzing. - +The method getting all commits to consider for the release will now test +whether the version in input is a valid reference. If it is not, it will +consider the whole log for the repository. + +evaluate_version_bump will still consider a message starting with the +version number as a breaking condition to stop analyzing. + Fixes #51 ([`252bffd`](https://github.com/python-semantic-release/python-semantic-release/commit/252bffd3be7b6dfcfdb384d24cb1cd83d990fc9a)) @@ -2968,14 +2994,14 @@ Fixes #51 ([`252bffd`](https://github.com/python-semantic-release/python-semanti * fix: Set version of click to >=2.0,<8.0. (#155) -* fix: Upgrade to click 7.0. - -Fixes #117 - -* fix: Instead of requiring click 7.0, looks like all tests will pass with at least 2.0. - -* Upstream is at ~=7.0, so let's set the range to less than 8.0. - +* fix: Upgrade to click 7.0. + +Fixes #117 + +* fix: Instead of requiring click 7.0, looks like all tests will pass with at least 2.0. + +* Upstream is at ~=7.0, so let's set the range to less than 8.0. + * The string template has no variables, so remove the call to .format() ([`f07c7f6`](https://github.com/python-semantic-release/python-semantic-release/commit/f07c7f653be1c018e443f071d9a196d9293e9521)) @@ -3166,9 +3192,9 @@ The commands is lacking from the documentation. ([`b6fa04d`](https://github.com/ ### Refactor -* refactor: added debug to hvcshvcs - +* refactor: added debug to hvcshvcs + module did not have any debug ([`0c6237b`](https://github.com/python-semantic-release/python-semantic-release/commit/0c6237bc01ec39608fb768925091c755d9bb25bd)) * refactor: fix import sorting ([`01e4c5d`](https://github.com/python-semantic-release/python-semantic-release/commit/01e4c5d743f2f237d2c85481118e467d4f5fde15)) @@ -3192,14 +3218,14 @@ module did not have any debug ([`0c6237b`](https://github.com/python-semantic-re * fix: Maintain version variable formatting on bump (#103) -Small change to the way the version is written to the config file it is read from. This allows the formatting to be the same as before semantic-release changed it. - -Prior behavior -`my_version_var="1.2.3"` => `my_version_var = '1.2.4'` - -New behavior -`my_version_var="1.2.3"` => `my_version_var="1.2.4"` - +Small change to the way the version is written to the config file it is read from. This allows the formatting to be the same as before semantic-release changed it. + +Prior behavior +`my_version_var="1.2.3"` => `my_version_var = '1.2.4'` + +New behavior +`my_version_var="1.2.3"` => `my_version_var="1.2.4"` + I am using python-semantic-release with a Julia project and this change will allow for consistent formatting in my Project.toml file where the version is maintained ([`bf63156`](https://github.com/python-semantic-release/python-semantic-release/commit/bf63156f60340614fae94c255fb2f097cf317b2b)) * fix: initialize git Repo from current folder @@ -3328,8 +3354,8 @@ Closes #88 re #32 ([`8df5e2b`](https://github.com/python-semantic-release/pytho * fix: Change requests from fixed version to version range (#93) -* Change requests version to be more flexible to aid in using this with dev requirements for a release. - +* Change requests version to be more flexible to aid in using this with dev requirements for a release. + * revert changes to vcs helpers ([`af3ad59`](https://github.com/python-semantic-release/python-semantic-release/commit/af3ad59f018876e11cc3acdda0b149f8dd5606bd)) ### Refactor @@ -3401,21 +3427,21 @@ Change the Gitpython version number to fix a bug described in #80. ([`23c9d4b`]( * feat: Add support to finding previous version from tags if not using commit messages (#68) -* feat: Be a bit more forgiving to find previous tags - -Now grabs the previous version from tag names if it can't find it in the commit - -* quantifiedcode and flake8 fixes - -* Update cli.py - +* feat: Be a bit more forgiving to find previous tags + +Now grabs the previous version from tag names if it can't find it in the commit + +* quantifiedcode and flake8 fixes + +* Update cli.py + * Switch to ImproperConfigurationError ([`6786487`](https://github.com/python-semantic-release/python-semantic-release/commit/6786487ebf4ab481139ef9f43cd74e345debb334)) * feat: Add --retry cli option (#78) -* Add --retry cli option -* Post changelog correctly -* Add comments +* Add --retry cli option +* Post changelog correctly +* Add comments * Add --retry to the docs ([`3e312c0`](https://github.com/python-semantic-release/python-semantic-release/commit/3e312c0ce79a78d25016a3b294b772983cfb5e0f)) ### Fix @@ -3451,9 +3477,9 @@ Fixes #74 ([`1dc306b`](https://github.com/python-semantic-release/python-semanti * fix: error when not in git repository (#75) -Fix an error when the program was run in a non-git repository. It would -not allow the help options to be run. - +Fix an error when the program was run in a non-git repository. It would +not allow the help options to be run. + issue #74 ([`251b190`](https://github.com/python-semantic-release/python-semantic-release/commit/251b190a2fd5df68892346926d447cbc1b32475a)) ### Unknown @@ -3507,12 +3533,12 @@ This reverts commit 93e5507da6d53ecf63405507390633ef480c52fb. ([`195ed8d`](https * feat: Add git hash to the changelog (#65) -* feat(*): add git hash to the changelog - -Add git hash to the changelog to ease finding the specific commit. The hash now is also easily viewable in Github's tag. see #63 for more information. - -* chore(test_history): fix test errors - +* feat(*): add git hash to the changelog + +Add git hash to the changelog to ease finding the specific commit. The hash now is also easily viewable in Github's tag. see #63 for more information. + +* chore(test_history): fix test errors + Fix the test errors that would happen after the modification of get_commit_log. ([`628170e`](https://github.com/python-semantic-release/python-semantic-release/commit/628170ebc440fc6abf094dd3e393f40576dedf9b)) ### Fix @@ -4226,7 +4252,7 @@ parsed. ([`974ccda`](https://github.com/python-semantic-release/python-semantic- * Merge pull request #15 from jezdez/python-2 -Add Python 2.7 support. Fix #10. +Add Python 2.7 support. Fix #10. :sparkles: ([`5daabb7`](https://github.com/python-semantic-release/python-semantic-release/commit/5daabb75eb9145566a2a7c2a9e64439df7cd85f1)) * Add Python 2.7 support. Fix #10. ([`c05e13f`](https://github.com/python-semantic-release/python-semantic-release/commit/c05e13f22163237e963c493ffeda7e140f0202c6)) diff --git a/pyproject.toml b/pyproject.toml index 948f7052f..dfbde9464 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" [project] name = "python-semantic-release" -version = "8.7.1" +version = "8.7.2" description = "Automatic Semantic Versioning for Python projects" requires-python = ">=3.7" license = { text = "MIT" } diff --git a/semantic_release/__init__.py b/semantic_release/__init__.py index 931879fdf..78d348028 100644 --- a/semantic_release/__init__.py +++ b/semantic_release/__init__.py @@ -23,7 +23,7 @@ tags_and_versions, ) -__version__ = "8.7.1" +__version__ = "8.7.2" def setup_hook(argv: list[str]) -> None: