Skip to content

Commit 6999a89

Browse files
authored
Merge pull request #1218 from sudo-bmitch/pr-release-notice
Add step to update website after a release
2 parents 1300cc3 + 0ef13af commit 6999a89

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

RELEASES.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ To avoid unfortunate side effects (onerous backwards compatibility requirements
2929

3030
Every OCI specification project SHOULD hold meetings that involve maintainers reviewing pull requests, debating outstanding issues, and planning releases.
3131
This meeting MUST be advertised on the project README and MAY happen on a phone call, video conference, or on IRC.
32-
Maintainers MUST send updates to the dev@opencontainers.org with results of these meetings.
32+
Maintainers MUST send updates to the <dev@opencontainers.org> with results of these meetings.
3333

3434
Before the specification reaches v1.0.0, the meetings SHOULD be weekly.
3535
Once a specification has reached v1.0.0, the maintainers may alter the cadence, but a meeting MUST be held within four weeks of the previous meeting.
3636

37-
The release plans, corresponding milestones and estimated due dates MUST be published on GitHub (e.g. https://github.com/opencontainers/runtime-spec/milestones).
37+
The release plans, corresponding milestones and estimated due dates MUST be published on GitHub (e.g. <https://github.com/opencontainers/runtime-spec/milestones>).
3838
GitHub milestones and issues are only used for community organization and all releases MUST follow the [project governance](GOVERNANCE.md) rules and procedures.
3939

4040
### Timelines
@@ -48,8 +48,6 @@ Specifications have a variety of different timelines in their lifecycle.
4848
For example if a breaking change is introduced in v1.0.0-rc2 then the series would end with v1.0.0-rc4 and v1.0.0.
4949
* Minor and patch releases SHOULD be made on an as-needed basis.
5050

51-
[charter]: https://github.com/opencontainers/tob/blob/main/CHARTER.md
52-
5351
## Checklist
5452

5553
Releases usually follow a few steps:
@@ -65,14 +63,15 @@ Releases usually follow a few steps:
6563
* [ ] drop hash and indent, `:'<,'> s/^\w* /^I* /`
6664
* [ ] a commit bumping `./specs-go/version.go` to next version and empty the `VersionDev` variable
6765
* [ ] a commit adding back the "+dev" to `VersionDev`
68-
* [ ] send email to dev@opencontainers.org
66+
* [ ] send email to <dev@opencontainers.org>
6967
* [ ] copy the exact commit hash for bumping the version from the pull-request (since master always stays as "-dev")
7068
* [ ] count the PRs since last release (that this version is tracking, in the cases of multiple branching), like `git log --pretty=oneline --no-merges --decorate $priorTag..$versionBumpCommit | grep \(pr\/ | wc -l`
7169
* [ ] get the date for a week from now, like `TZ=UTC date --date='next week'`
7270
* [ ] OPTIONAL find a cute animal gif to attach to the email, and subsequently the release description
7371
* [ ] subject line like `[runtime-spec VOTE] tag $versionBumpCommit as $version (closes $dateWeekFromNowUTC)`
7472
* [ ] email body like
75-
```
73+
74+
```text
7675
Hey everyone,
7776
7877
There have been $numPRs PRs merged since $priorTag release (https://github.com/opencontainers/runtime-spec/compare/$priorTag...$versionBumpCommit).
@@ -83,14 +82,18 @@ Please respond LGTM or REJECT (with reasoning).
8382
8483
$sig
8584
```
86-
* [ ] edit/update the pull-request to link to the VOTE thread, from https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
85+
86+
* [ ] edit/update the pull-request to link to the VOTE thread, from <https://groups.google.com/a/opencontainers.org/forum/#!forum/dev>
8787
* [ ] a week later, if the vote passes, merge the PR
8888
* [ ] `git tag -s $version $versionBumpCommit`
8989
* [ ] `git push --tags`
9090
* [ ] produce release documents
9191
* [ ] git checkout the release tag, like `git checkout $version`
9292
* [ ] `make docs`
9393
* [ ] rename the output PDF and HTML file to include version, like `mv output/oci-runtime-spec.pdf output/oci-runtime-spec-$version.pdf``
94-
* [ ] attach these docs to the release on https://github.com/opencontainers/runtime-spec/releases
94+
* [ ] attach these docs to the release on <https://github.com/opencontainers/runtime-spec/releases>
9595
* [ ] link to the the VOTE thread and include the passing vote count
9696
* [ ] link to the pull request that merged the release
97+
* [ ] add release notes to the website <https://github.com/opencontainers/opencontainers.org/tree/main/content/release-notices>
98+
99+
[charter]: https://github.com/opencontainers/tob/blob/main/CHARTER.md

0 commit comments

Comments
 (0)