Add issue template for cutting releases #2403
Conversation
.github/ISSUE_TEMPLATE/release.md
Outdated
| <!-- Please complete the following steps in order. --> | ||
|
|
||
| I have: | ||
| <!-- Please uncomment the following section only if cutting a minor release. These should be completed at the beginning of [Code Freeze](https://crossplane.io/docs/v1.2/reference/release-cycle.html#code-freeze). --> |
There was a problem hiding this comment.
Should we wrap this? I'm not sure whether GitHub wraps this when you use the template.
There was a problem hiding this comment.
We could wrap this one -- though it won't actually ever be uncommented. Some of the placholder links did not render well when wrapped, so this template is somewhat pseudo-wrapped right now.
There was a problem hiding this comment.
My auto-wrapper doesn't wrap comments I have now discovered, but everything that is not a comment or may be un-commented has now been wrapped 👍
.github/ISSUE_TEMPLATE/release.md
Outdated
| with the next release candidate tag ([Tag](Link to tag, e.g. v1.4.0-rc.0)). | ||
| --> | ||
| - [ ] Updated all version information in the documentation on the relevant | ||
| release branch ([PR](<!-- Link to merged PR, e.g. https://github.com/crossplane/crossplane/pull/2386 -->)). |
There was a problem hiding this comment.
I think this template would be a lot more readable if we used footer style links here - this would let us keep all the links we needed to insert down in one list at the bottom.
There was a problem hiding this comment.
@negz do you mean for these links that need to be filled in by the person cutting the release? I fell like that might be somewhat cumbersome to have to match the footer link with the link in the body.
There was a problem hiding this comment.
Yes, I do mean for these links. This is probably subjective, but do I think using footer links would:
- Make the template easier to read and follow in its raw markdown form (which is how it will mostly be interacted with).
- Make it somewhat easier to insert links (rather than having to inject them into braces inline in the template).
You can use descriptive link names e.g. [PR][link-to-pr] to make it very clear what links folks need to fill out down the bottom.
There was a problem hiding this comment.
My primary concern is less experienced folks not filling out the links because they are not as obvious that they are blank. That being said, I have added a note in a comment and am willing to try this strategy.
Adds an issue template for cutting minor and patch releases. Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
hasheddan
force-pushed
the
release-issue-template
branch
from
d97164c
to
8a9eb79
Compare
Description of your changes
Adds an issue template for cutting minor and patch releases.
Signed-off-by: hasheddan georgedanielmangum@gmail.com
Fixes #2169
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
n/a