Skip to content

Commit 45d6568

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

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

RELEASE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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 with the following changes:
8+
- [ ] Bump the version to the target version in:
9+
- [ ] The `CurrentVersion` in `specs-go/versions.go`
10+
- [ ] The `tags.cncf.io/container-device-interface` version in `schema/go.mod`
11+
- [ ] (*for spec changes only*) The `tags.cncf.io/container-device-interface/specs-go` version in go.mod
12+
- [ ] (*for spec 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 spec changes only*) A a description to the spec changes in `SPEC.md`
16+
- [ ] 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 spec 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 spec 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.

0 commit comments

Comments
 (0)