search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
90 stars 63 forks source link

Changelog as part of GitHub releases #175

Open jonesbusy opened 8 months ago

jonesbusy commented 8 months ago

Hi,

The changelog of mkdocs-techdocs-core is now on the README.md

On GitHub it's a good practice to create GitHub releases with changelog there.

For example when bots like renovate bump version of a package the release note is included on the PR.

Example here that the release note is missing

include_github_release

If we look at backstage

release_notes

Because this it creates GitHub release (https://github.com/backstage/backstage/releases)

Please consider also creating GitHub release so that people sticking package version and using tool to renovate those package have also release notes on the PR.

Thanks!

pwalleni commented 7 months ago

Agree.

awanlin commented 4 months ago

I'll bring this up with the team, there might be some patterns we can reuse from the main Backstage repo for this. 👍

github-actions[bot] commented 1 week ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

jonesbusy commented 1 week ago

Not stale