Skip to content

chore: add psr specific changelog templates#1155

Merged
codejedi365 merged 3 commits intopython-semantic-release:masterfrom
codejedi365:chore/psr-changelog-templates
Jan 27, 2025
Merged

chore: add psr specific changelog templates#1155
codejedi365 merged 3 commits intopython-semantic-release:masterfrom
codejedi365:chore/psr-changelog-templates

Conversation

@codejedi365
Copy link
Copy Markdown
Contributor

@codejedi365 codejedi365 commented Jan 27, 2025

Purpose

  • Add changelog to documentation site
  • Set some PSR specific release note content

Rationale

Simplifies the release process as I can't keep the default changelog up to date with the desired changelog for PSR. This also brings the changelog to the forefront for actual review by consumers if desired

How did you test?

Many manual tests of both the changelog generation (removal and then re-generate) and the release notes generation. I also ensure that the documentation presented correctly via sphinx.

How to Verify

rm CHANGELOG.md && semantic-release changelog

semantic-release --noop changelog --post-to-release-tag v9.17.0

rm -fr docs/_build && sphinx-autobuild docs/ docs/_build/html --open-browser --port 9000

@codejedi365 codejedi365 self-assigned this Jan 27, 2025
@codejedi365 codejedi365 merged commit 2f18a6d into python-semantic-release:master Jan 27, 2025
@codejedi365 codejedi365 deleted the chore/psr-changelog-templates branch January 27, 2025 05:25
@codejedi365
Copy link
Copy Markdown
Contributor Author

🎉 This PR has been published as part of Version 9.18.0 🎉

You can find more information about this release on the GitHub Releases page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant