Skip to content

Add RELEASE.md with steps to create a release #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

elezar
Copy link
Contributor

@elezar elezar commented Mar 7, 2025

These changes add a document listing the steps of the release process.

See the following PRs for version-bump changes:

@elezar elezar requested review from klihub and bart0sh March 7, 2025 09:27
RELEASE.md Outdated
- [ ] (*for spec changes only*) The `tags.cncf.io/container-device-interface/specs-go` version in `schema/go.mod`
- [ ] Run `make mod-tidy` to update versions in `cmd/**/go.mod`
- [ ] Run `make mod-verify` to ensure modules are up to date.
- [ ] (*for spec changes only*) A a description to the spec changes in `SPEC.md`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: was probably meant to be Add a description...

Copy link
Contributor

@klihub klihub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, apart from a small typo.

RELEASE.md Outdated
- [ ] (*for spec changes only*) Create a `specs-go/vx.y.w` tag. (for the first spec version `w` will be the same as `z`)
- [ ] Create a GitHub release form the `vx.y.z` tag.
- [ ] (*for spec changes only*) Create a GitHub release from the `specs-go/vx.y.w` tag.
- [ ] Close the release issue,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: trailing comma looks weird.
über-nit: maybe we should end either all or none of the sentences with a .. Now it looks a bit random.

@elezar elezar force-pushed the document-release-process branch from 45d6568 to 57e4b58 Compare March 7, 2025 09:42
@elezar elezar force-pushed the document-release-process branch from 57e4b58 to 8aa91e1 Compare March 7, 2025 09:45
@bart0sh bart0sh merged commit a097fb1 into cncf-tags:main Mar 7, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants