Skip to content

Commit 85dffcf

Browse files
klihubelezar
andcommitted
.github: add issue template for releases.
Add and issue template for new releases, update RELEASE.md accordingly. Co-authored-by: Evan Lezar <[email protected]> Signed-off-by: Krisztian Litkey <[email protected]>
1 parent 40e4c31 commit 85dffcf

File tree

2 files changed

+37
-21
lines changed

2 files changed

+37
-21
lines changed

.github/ISSUE_TEMPLATE/new-release.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: New Release
3+
about: Propose a New Release
4+
title: Release vX.Y.Z
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Release Process
10+
11+
<!--
12+
If making adjustments to the checklist, please also file a PR against
13+
this issue template (.github/ISSUE_TEMPLATE/new-release.md) to update
14+
it accordingly for future releases.
15+
-->
16+
17+
- [ ] Create a PR titled `Bump version to vX.Y.Z` including the following changes:
18+
- [ ] Change the following to the target version `vX.Y.Z`:
19+
- [ ] the `CurrentVersion` in `specs-go/versions.go`,
20+
- [ ] the `tags.cncf.io/container-device-interface` version in `schema/go.mod`,
21+
- [ ] (*for specification changes only*) the `tags.cncf.io/container-device-interface/specs-go` version in go.mod,
22+
- [ ] (*for specification changes only*) the `tags.cncf.io/container-device-interface/specs-go` version in `schema/go.mod`.
23+
- [ ] Run `make mod-tidy` to update versions in `cmd/**/go.mod`.
24+
- [ ] Run `make mod-verify` to ensure modules are up to date.
25+
- [ ] (*for specification changes only*) Add a description to the specification changes in `SPEC.md`.
26+
- [ ] (*for specification changes only*) Implement a `requiresV*` function for the target version in `specs-go/versions.go`.
27+
- [ ] Merge the PR on sufficient approval.
28+
- [ ] Create a `vX.Y.Z` tag.
29+
- [ ] (*for specification changes only*) Create a `specs-go/vX.Y.W` tag. (for the first spec version `W` will be the same as `Z`)
30+
- [ ] Create a GitHub release form the `vX.Y.Z` tag.
31+
- [ ] (*for specification changes only*) Create a GitHub release from the `specs-go/vX.Y.Z` tag.
32+
- [ ] Close the release issue.

RELEASE.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,9 @@
11
# Release Process
22

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).
44

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.
5+
If you plan or propose a new release:
6+
7+
1. [Open a new issue using the template](https://github.com/cncf-tags/container-device-interface/issues/new?template=new-release.md) for it.
8+
1. Follow the steps as drescribed in the issue.
259
1. If required, create PRs or issues in clients referencing the release issue to update their dependencies.

0 commit comments

Comments
 (0)