Python-semantic-release

Documentation

- **github-actions**: Clarify & consolidate GitHub Actions usage docs
([1011](https://github.com/python-semantic-release/python-semantic-release/pull/1011),
[`2135c68`](https://github.com/python-semantic-release/python-semantic-release/commit/2135c68ccbdad94378809902b52fcad546efd5b3))

Resolves: 907

* chore(scripts): remove non-existant file from version bump script

* docs(automatic-releases): drop extrenous github push configuration

* docs(homepage): remove link to old github config & update token scope config

* docs(github-actions): expand descriptions & clarity of actions configs

* docs(github-actions): add configuration & description of publish action

* docs(github-actions): revert removal of namespace prefix from examples

Features

- **github-actions**: Add `is_prerelease` output to the version action
([1038](https://github.com/python-semantic-release/python-semantic-release/pull/1038),
[`6a5d35d`](https://github.com/python-semantic-release/python-semantic-release/commit/6a5d35d0d9124d6a6ee7910711b4154b006b8773))

* test(github-actions): add test to ensure `is_prerelease` is a action output

* docs(github-actions): add description of new `is_prerelease` output for version action

Bug Fixes

- **version-cmd**: Improve `version_variables` flexibility w/ quotes (ie. json, yaml, etc)
([1028](https://github.com/python-semantic-release/python-semantic-release/pull/1028),
[`156915c`](https://github.com/python-semantic-release/python-semantic-release/commit/156915c7d759098f65cf9de7c4e980b40b38d5f1))

* fix(version-cmd): increase `version_variable` flexibility with quotations (ie. json, yaml, etc)

Previously json would not work due to the key being wrapped in quotes, yaml also has issues when it
does not usually use quotes. The regex we created originally only wrapped the version to be
replaced in quotes but now both the key and version can optionally be wrapped in different kind of
quotations.

Resolves: 601, 706, 962, 1026

* docs(configuration): add clarity to `version_variables` usage & limitations

Ref: 941

* fix(version-cmd): ensure `version_variables` do not match partial variable names

* build(deps-test): add `PyYAML` as a test dependency

* test(fixtures): refactor location of fixture for global use of cli runner

* test(stamp-version): add test cases to stamp json, python, & yaml files

Documentation

- Update docstrings to resolve sphinx failures
([1030](https://github.com/python-semantic-release/python-semantic-release/pull/1030),
[`d84efc7`](https://github.com/python-semantic-release/python-semantic-release/commit/d84efc7719a8679e6979d513d1c8c60904af7384))

set `ignore-module-all` for `autodoc_default_options` to resolve some Sphinx errors about duplicate
/ ambiguous references https://github.com/sphinx-doc/sphinx/issues/4961#issuecomment-1543858623

Standardize some non-standard (Google-ish) docstrings to Sphinx format, to avoid ruff and Sphinx
arguing about underline length.

Fix indents and other minor whitespace / formatting changes.

Fixes 1029

Bug Fixes

- **config**: Fix path traversal detection for windows compatibility
([1014](https://github.com/python-semantic-release/python-semantic-release/pull/1014),
[`16e6daa`](https://github.com/python-semantic-release/python-semantic-release/commit/16e6daaf851ce1eabf5fbd5aa9fe310a8b0f22b3))

The original implementation of the path traversal detection expected that `resolve()` works the same
on windows as it does with Linux/Mac. Windows requires the folder paths to exist to be resolved
and that is not the case when the `template_dir` is not being used.

Resolves: 994

Documentation

- **configuration**: Update `build_command` env table for windows to use all capital vars
([`0e8451c`](https://github.com/python-semantic-release/python-semantic-release/commit/0e8451cf9003c6a3bdcae6878039d7d9a23d6d5b))

- **github-actions**: Update version in examples to latest version
([`3c894ea`](https://github.com/python-semantic-release/python-semantic-release/commit/3c894ea8a555d20b454ebf34785e772959bbb4fe))

Bug Fixes

- Provide `context.history` global in release notes templates
([1005](https://github.com/python-semantic-release/python-semantic-release/pull/1005),
[`5bd91b4`](https://github.com/python-semantic-release/python-semantic-release/commit/5bd91b4d7ac33ddf10446f3e66d7d11e0724aeb2))

* fix(release-notes): provide `context.history` global in release note templates

Temporarily return the `context.history` variable to release notes generation as many users are
using it in their release documentation. It was never intended to be provided and will be removed
in the future.

context was removed in `v9.8.3` during a refactor and condensing of changelog and release notes
functionality.

Resolves: 984

* fix(release-notes): fix noop-changelog to print raw release notes

Some markdown sequences can be interpreted as ansi escape sequences which dilute debugging of
release note templates by the user. This change ensures the raw content is displayed to the
console as expected.

Documentation

- Use pinned version for GHA examples
([1004](https://github.com/python-semantic-release/python-semantic-release/pull/1004),
[`5fdf761`](https://github.com/python-semantic-release/python-semantic-release/commit/5fdf7614c036a77ffb051cd30f57d0a63c062c0d))

* docs(github-actions): use pinned version for GHA examples

Fixes 1003

* chore(scripts): add auto version bump to non dynamic docs text (i.e. code snippets)

* docs(github-actions): adjust formatting & version warning in code snippets

* style(docs-github-actions): adjust formatting for readability

---------

Co-authored-by: codejedi365 <codejedi365gmail.com>

- **changelog**: Clarify description of the default changelog generation process
([`399fa65`](https://github.com/python-semantic-release/python-semantic-release/commit/399fa6521d5c6c4397b1d6e9b13ea7945ae92543))

- **configuration**: Clarify `changelog_file` vs `template_dir` option usage
([`a7199c8`](https://github.com/python-semantic-release/python-semantic-release/commit/a7199c8cd6041a9de017694302e49b139bbcb034))

Provided additional description that warns about the mutually-exclusive nature of the
`changelog_file` option and the `template_dir` option.

Resolves: 983

- **configuration**: Fix build_command_env table rendering
([996](https://github.com/python-semantic-release/python-semantic-release/pull/996),
[`a5eff0b`](https://github.com/python-semantic-release/python-semantic-release/commit/a5eff0bfe41d2fd5d9ead152a132010b718b7772))

Bug Fixes

- **version-cmd**: Resolve build command execution in powershell
([980](https://github.com/python-semantic-release/python-semantic-release/pull/980),
[`32c8e70`](https://github.com/python-semantic-release/python-semantic-release/commit/32c8e70915634d8e560b470c3cf38c27cebd7ae0))

Fixes the command line option for passing a shell command to Powershell. Also included a similar
shell detection result for pwsh (Powershell Core)

Documentation

- **configuration**: Correct GHA parameter name for commit email
([981](https://github.com/python-semantic-release/python-semantic-release/pull/981),
[`ce9ffdb`](https://github.com/python-semantic-release/python-semantic-release/commit/ce9ffdb82c2358184b288fa18e83a4075f333277))

`git_committer_name` was repeated; replace one instance of it with `git_committer_email`

Bug Fixes

- Enable `--print-last-released*` when in detached head or non-release branch
([926](https://github.com/python-semantic-release/python-semantic-release/pull/926),
[`782c0a6`](https://github.com/python-semantic-release/python-semantic-release/commit/782c0a6109fb49e168c37f279928c0a4959f8ac6))

* test(version-cmd): add tests to print when detached or non-release branch

ref: 900

* fix(version-cmd): drop branch restriction for `--print-last-released*` opts

Resolves: 900

Performance Improvements

- Improve git history processing for changelog generation
([972](https://github.com/python-semantic-release/python-semantic-release/pull/972),
[`bfda159`](https://github.com/python-semantic-release/python-semantic-release/commit/bfda1593af59e9e728c584dd88d7927fc52c879f))

* perf(changelog): improve git history parser changelog generation

This converts the double for-loop (`O(n^2)`) down to `O(n)` using a lookup table to match the
current commit with a known tag rather than iterating through all the tags of the repository every
time.

* fix(changelog): resolve commit ordering issue when dates are similar