-
Notifications
You must be signed in to change notification settings - Fork 144
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
Add initial release-drafter workflow #3125
base: main
Are you sure you want to change the base?
Conversation
default: patch | ||
replacers: | ||
- search: '/releases\.html#tmt-(\d+)\.(\d+)\.(\d+)/' | ||
replace: 'releases.html#tmt-$1-$2-$3' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would require consistent versioning in tmt.readthedocs going forward. For example: 1.35.0
as opposed to 1.35
.
Historically, it has not been the case: e.g. tmt-1.32
, tmt-1.32.2
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a similar action changesets/action
(example) which instead of creating draft releases, it creates an "immortal" PR. Wdyt about that workflow?
Co-authored-by: Cristian Le <[email protected]>
Not sure about this tbh. |
The main difference is that with the draft releases is that it is only visible to GH contributors, while the PR is more interactive. |
Well, there is docs/releases.rst for that. |
To further automate the release process, I've been looking into github releases. After evaluating various options, like
.github/release.yml
, I'm proposing release-drafter , which seems to be the most popular tool specifically for this.The initial template aims to keep everything as is, but could be a base to further improve the release notes (see available configuration options)
Note I've added:
this, or some similarly named label could be used for merges that should be omitted from release notes, e.g. single-line typo fix that blocks release :)
TODO:
replacers
for tmt rtd link