chore: split release issue template - #2110
Conversation
|
@garethbowen @matthew-white The split was originally suggested by Gareth some weeks ago, and based on my last experience helping with the patch release, I believe it reduces noise during release. I tried to keep the changes to a minimum, just extracting text to the other template. |
| name: Release | ||
| about: Checklist for releasing a new version of ODK Central | ||
| title: 'Release vXXXX.X.Y' | ||
| about: Checklist for releasing a new major version of ODK Central |
There was a problem hiding this comment.
Initially I had a comment about how it's major OR minor, but I see our existing language just talks about major vs patch. I think that's ok as long as nobody is confused as to why there's no minor checklist...
There was a problem hiding this comment.
I was wondering the same, but I've heard the Central team call it major.
In this format, what would be considered a major release for a format that has the year (2026.2.0)? Would it be the first release of a given year (2027.1.0)? 馃槄
I'm going to remove the word major and leave it plain.
|
|
||
| ### Update submodules | ||
|
|
||
| - [ ] For each of the server and client submodules, `cd` into the directory and run: |
There was a problem hiding this comment.
There is no client submodule any more, right?
There was a problem hiding this comment.
I've updated the step
Warning
Branch off and target
next, notmaster. Themasteris stable and used in production (exception: documentation/infrastructure-only changes).What has been done to verify that this works as intended?
Followed the pattern of the other issue templates and double-checked that no steps are missing
Why is this the best possible solution? Were any other approaches considered?
Initially, it was Gareth's feedback, but after the recent release, I often read the steps and wondered whether they apply to patch or major releases. I believe this makes it easier to follow with less cognitive load.
How does this change impact users? Describe intentional behavior changes from code updates. What are the regression risks?
No
Does this change require updates to documentation? If so, please file an issue here and include the link below.
No