Add Release documentation #8786
Conversation
This adds documentation that describes the release train model, feature flags, versioning system, merge process, and uplift process.
docs/RELEASES.md
Outdated
| Risk to taking this patch (and alternatives if risky): | ||
| ``` | ||
|
|
||
| ## Create K-9 Mail releases |
There was a problem hiding this comment.
This section describes the manual release process, mostly. I think it might be useful to keep in some form, let's say the apocalypse happens and GitHub actions are no longer available or certain steps fail, we'd know how to do it manually.
Otherwise I'd rather suggest this section describes how we trigger releases, what manual intervention is necessary, etc.
If you'd rather do this incrementally I'm fine with adding this section as long as we add a NOTE at the top of the section that we do things automatically now.
docs/RELEASES.md
Outdated
| ### Release a stable version | ||
|
|
||
| When the team decides the `main` branch is stable enough and it's time to release a new stable version, create a new | ||
| maintenance branch (off `main`) using the desired version number with the last two digits dropped followed by `-MAINT`. |
There was a problem hiding this comment.
This might also be confusing as we don't use -MAINT in the new system any more. See former comment though.
coreycb
force-pushed
the
releases-doc
branch
5 times, most recently
from
421f243 to
36fb083
Compare
Moves the manual releasing documentation back to the RELEASING.md file and adds general steps for automated releases to the RELEASES.md file.
Updates based on comments from Wolf.
|
@wmontwe Thanks for the review and apologies for the delay. I'm pushing updates now based on your comments. |
This adds documentation that describes the release train model, feature flags, versioning system, merge process, and uplift process.