Skip to content

Commit 8aa91e1

Browse files
committed
Add RELEASE.md with steps to create a release
Signed-off-by: Evan Lezar <[email protected]>
1 parent 3a09dd0 commit 8aa91e1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

RELEASE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Release Process
2+
3+
This document describes the release process for the Container Device Interface.
4+
5+
1. Create an issue titled `Release container-device-interface vx.y.z` with the following content:
6+
```
7+
- [ ] Create a PR titled `Bump version to vx.y.z` including the following changes:
8+
- [ ] Change the following to the target version `vx.y.z`:
9+
- [ ] the `CurrentVersion` in `specs-go/versions.go`,
10+
- [ ] the `tags.cncf.io/container-device-interface` version in `schema/go.mod`,
11+
- [ ] (*for specification changes only*) the `tags.cncf.io/container-device-interface/specs-go` version in go.mod,
12+
- [ ] (*for specification changes only*) the `tags.cncf.io/container-device-interface/specs-go` version in `schema/go.mod`.
13+
- [ ] Run `make mod-tidy` to update versions in `cmd/**/go.mod`.
14+
- [ ] Run `make mod-verify` to ensure modules are up to date.
15+
- [ ] (*for specification changes only*) Add a description to the specification changes in `SPEC.md`.
16+
- [ ] (*for specification changes only*) Implement a `requiresV*` function for the target version in `specs-go/versions.go`.
17+
- [ ] Merge the PR on sufficient approval.
18+
- [ ] Create a `vx.y.z` tag.
19+
- [ ] (*for specification changes only*) Create a `specs-go/vx.y.w` tag. (for the first spec version `w` will be the same as `z`)
20+
- [ ] Create a GitHub release form the `vx.y.z` tag.
21+
- [ ] (*for specification changes only*) Create a GitHub release from the `specs-go/vx.y.w` tag.
22+
- [ ] Close the release issue.
23+
```
24+
1. Follow the steps as drescribed.
25+
1. If required, create PRs or issues in clients referencing the release issue to update their dependencies.

0 commit comments

Comments
 (0)