-
Notifications
You must be signed in to change notification settings - Fork 663
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feat: Pin external references on a release
This pins references to external specs (distribution and runtime) to their latest release on a release of this project. Signed-off-by: Brandon Mitchell <[email protected]>
- Loading branch information
1 parent
da92727
commit 5db69d9
Showing
2 changed files
with
35 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
#!/bin/sh | ||
|
||
set -e | ||
cd "$(dirname $0)/.." | ||
|
||
if [ ! -x "$(command -v curl )" ] || [ ! -x "$(command -v jq )" ] || [ ! -x "$(command -v find )" ] || [ ! -x "$(command -v sed )" ]; then | ||
echo "This command requires the following to run: curl, find, jq, and sed" >&2 | ||
exit 1 | ||
fi | ||
|
||
runtime_tag=$(curl -L \ | ||
-H "Accept: application/vnd.github+json" \ | ||
-H "X-GitHub-Api-Version: 2022-11-28" \ | ||
https://api.github.com/repos/opencontainers/runtime-spec/releases/latest \ | ||
| jq -r .tag_name) | ||
|
||
distribution_tag=$(curl -L \ | ||
-H "Accept: application/vnd.github+json" \ | ||
-H "X-GitHub-Api-Version: 2022-11-28" \ | ||
https://api.github.com/repos/opencontainers/distribution-spec/releases/latest \ | ||
| jq -r .tag_name) | ||
|
||
find . -name '*.md' -exec sed -i \ | ||
-e "s#https://github.com/opencontainers/runtime-spec/blob/main/#https://github.com/opencontainers/runtime-spec/blob/${runtime_tag}/#g" \ | ||
-e "s#https://github.com/opencontainers/distribution-spec/blob/main/#https://github.com/opencontainers/distribution-spec/blob/${distribution_tag}/#g" \ | ||
'{}' \; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,7 +34,7 @@ Maintainers MUST send updates to the <[email protected]> with results of th | |
Before the specification reaches v1.0.0, the meetings SHOULD be weekly. | ||
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. | ||
|
||
The release plans, corresponding milestones and estimated due dates MUST be published on GitHub (e.g. <https://github.com/opencontainers/runtime-spec/milestones>). | ||
The release plans, corresponding milestones and estimated due dates MUST be published on GitHub (e.g. <https://github.com/opencontainers/image-spec/milestones>). | ||
GitHub milestones and issues are only used for community organization and all releases MUST follow the [project governance](GOVERNANCE.md) rules and procedures. | ||
|
||
### Timelines | ||
|
@@ -53,18 +53,22 @@ Specifications have a variety of different timelines in their lifecycle. | |
Releases usually follow a few steps: | ||
|
||
- [ ] prepare a pull-request for the release | ||
- [ ] a commit updating `./ChangeLog` | ||
- [ ] generate a change log: | ||
- [ ] `git log --oneline --no-merges --decorate --name-status v1.0.1..HEAD | vim -` | ||
- [ ] `:% s/(pr\/\(\d*\))\(.*\)/\2 (#\1)/` to move the PR to the end of line and match previous formatting | ||
- [ ] review `(^M|^A|^D)` for impact of the commit | ||
- [ ] group commits to `Additions:`, `Minor fixes and documentation:`, `Breaking changes:` | ||
- [ ] delete the `(^M|^A|^D)` lines, `:%!grep -vE '(^M|^A|^D)'` | ||
- [ ] merge multi-commit PRs (so each line has a `(#num)` suffix) | ||
- [ ] drop hash and indent, `:'<,'> s/^\w* /^I* /` | ||
- [ ] a commit bumping `./specs-go/version.go` to next version and empty the `VersionDev` variable | ||
- [ ] a commit adding back the "+dev" to `VersionDev` | ||
- [ ] a commit for the release: | ||
- [ ] bump `./specs-go/version.go` to next version and empty the `VersionDev` variable | ||
- [ ] run `.tool/pin-release.sh` to pin the references to other specs | ||
- [ ] a commit to revert the main branch for development: | ||
- [ ] `git revert -n HEAD` | ||
- [ ] bump `./specs-go/version.go` to next version and set the `VersionDev` variable to `+dev` | ||
- [ ] send email to <[email protected]> | ||
- [ ] copy the exact commit hash for bumping the version from the pull-request (since master always stays as "-dev") | ||
- [ ] copy the exact commit hash for bumping the version from the pull-request (since master always stays as "+dev") | ||
- [ ] 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` | ||
- [ ] get the date for a week from now, like `TZ=UTC date --date='next week'` | ||
- [ ] OPTIONAL find a cute animal gif to attach to the email, and subsequently the release description | ||
|