-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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
Automated release notes #16633
Comments
Use github autogeneration release notes and add action to check if the PR has labels Complete and more readable relase notes https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
@OrlinVasilev we should also update the docs with this new process and what the labels mean. Maybe in the contributing guide? https://github.com/goharbor/harbor/blob/main/CONTRIBUTING.md#push-and-create-pr |
Also we should update any release docs we have. I'm not sure if there are any more specific release process docs for creating a release, though, other than this section in the releases.md file, https://github.com/goharbor/harbor/blob/main/RELEASES.md#publishing-a-new-release. |
Use github autogeneration release notes and add action to check if the PR has labels Complete and more readable relase notes https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
Add release.yml to automate release notes #16633
Use github autogeneration release notes and add action to check if the PR has labels Complete and more readable relase notes https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
This issue is being marked stale due to a period of inactivity. If this issue is still relevant, please comment or remove the stale label. Otherwise, this issue will close in 30 days. |
done |
Use github autogeneration release notes and add action to check if the PR has labels Complete and more readable relase notes https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
*Is your feature request related to a problem? Please describe.
The current release notes are not complete and we can do better
Describe the solution you'd like
Introduce proper labels and rules for writing new PRs so we can generate Release notes automagicaly
Add release.yml to ease out a bit the process
labels to be used in the future:
For release notes:
release-note/enhancement - make something better
release-note/new-feature - completely new feature
release-note/update - update current component - e.g. Bump Golang version
release-note/breaking-change - breaking changes
release-note/docs - docs update
release-note/community - change related to community
release-note/deprecation - deprecation change
To be skipped:
release-note/ignore-for-release- no need to be added into release notes
Describe the main design/architecture of your solution
Once we have proper setup for the PRs with Labels and good description it will be just click of a button to create release notes!
Add GitHub Action on PR creation to check if you have at least one label selected - mheap/github-action-required-labels@v1
Describe the development plan you've considered
Once we have that implemented we can invoke it from actions or manual on new tag/release created!
New release notes can look like:
Here is the example repo:
https://github.com/OrlinVasilev/release/releases/tag/v0.1
What's Changed
Exciting New Features 🎉
Component updates ⬆️
Breaking Changes 🛠
Deprecations ❌
Other Changes
New Contributors
Full Changelog: https://github.com/OrlinVasilev/release/commits/v0.1
The text was updated successfully, but these errors were encountered: