|
1 | 1 | # Release Process
|
2 | 2 |
|
3 |
| -This document describes the release process for the Container Device Interface. |
| 3 | +The release process is documented in the [issue template for new releases](.github/ISSUE_TEMPLATE/new-release.md). |
4 | 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. |
| 5 | +If you plan or propose a new release, [please open a new issue](https://github.com/cncf-tags/container-device-interface/issues/new?template=new-release.md) for it. |
0 commit comments