mkdocs-techdocs-core icon indicating copy to clipboard operation
mkdocs-techdocs-core copied to clipboard

Changelog as part of GitHub releases

Open jonesbusy opened this issue 1 year ago • 8 comments

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!

jonesbusy avatar Mar 08 '24 04:03 jonesbusy

Agree.

pwalleni avatar Apr 10 '24 09:04 pwalleni

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

awanlin avatar Jun 27 '24 18:06 awanlin