docs(releasing): update release-process.md; add notes template #2622
Conversation
vdice
requested review from
fibonacci1729,
mikkelhegn,
kate-goldenring and
me-diru
docs/content/release-process.md
Outdated
|
|
||
| # Create a GPG-signed and annotated tag | ||
| git tag -s -m "Spin v2.0.0" v2.0.0 | ||
| 1. If this is a major/minor release or first release candidate, create the release branch, e.g. `v2.0`. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/fermyon/spin/branches). |
There was a problem hiding this comment.
May I know what the first release candidate is?
There was a problem hiding this comment.
@me-diru The first release candidate is... well, the first candidate for a new release. Like if we are at 3.8, and we are preparing to release 4.0, we might, but do not necessarily, create a 4.0 release candidate. (Usually for minor versions we go straight to a release. Major versions may have RCs.) What this is saying is that, if we decide thr 4.0 release merits a RC, then the 4.0 release branch is created at RC time, not at final release time. And the RC is published from the 4.0 branch.
Does that answer your question? I am not 100% sure what you're asking for here...
There was a problem hiding this comment.
Makes sense, thanks! RC is for one to essentially create a timestamp to release in the future.
|
|
||
| # Create a GPG-signed and annotated tag | ||
| git tag -s -m "Spin v2.0.0-rc.1" v2.0.0-rc.1 | ||
| ## Notify downstream projects |
There was a problem hiding this comment.
Not sure if it is the release engineer's job to announce in Fermyon Discord as well?
There was a problem hiding this comment.
It could be. What do you think?
There was a problem hiding this comment.
I wasn't sure if they would have the necessary access to post in announcements. I think we could update it accordingly as the project evolves.
vdice
force-pushed
the
docs/release-process-updates
branch
from
578472e
to
3b1fbb3
Compare
Signed-off-by: Vaughn Dice <vaughn.dice@fermyon.com>
vdice
force-pushed
the
docs/release-process-updates
branch
from
3b1fbb3
to
4cca0ef
Compare
This updates the Release Process guide with a bit more instruction beyond the pre-existing release branch and git tag steps.
Also adds a release notes template.
This is just a first attempt at adding more details to the process that had previously been tracked elsewhere. Please nitpick, suggest, request more or less detail, point out missing steps, etc!