Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog as part of GitHub releases #175

Open
jonesbusy opened this issue Mar 8, 2024 · 4 comments
Open

Changelog as part of GitHub releases #175

jonesbusy opened this issue Mar 8, 2024 · 4 comments

Comments

@jonesbusy
Copy link
Contributor

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
Copy link

Agree.

@awanlin
Copy link
Collaborator

awanlin commented Jun 27, 2024

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

Copy link

github-actions bot commented Nov 9, 2024

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.

@github-actions github-actions bot added the stale label Nov 9, 2024
@jonesbusy
Copy link
Contributor Author

Not stale

@github-actions github-actions bot removed the stale label Nov 10, 2024
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

No branches or pull requests

3 participants