Skip to content
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.

Sign up for GitHub

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

Document how gvisor-tap-vsock releases are made #461

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document how gvisor-tap-vsock releases are made #461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions doc/MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Releasing gvisor-tap-vsock

Here are the steps to follow to make a gvisor-tap-vsock release.
Releases are automated through this GitHub Actions workflow:
https://github.com/containers/gvisor-tap-vsock/blob/main/.github/workflows/release.yml

- fetch the latest upstream code, and optionally check it out locally: `git remote update`
- create a v0.1.0 tag for a 0.1.0 release: `git tag -s v0.1.0 origin/main`
- push the tag: `git push origin v0.1.0`
- wait until the "Release build" GitHub Actions workflow completes
- go to https://github.com/containers/gvisor-tap-vsock/releases. There should now be a v0.1.0 release with a Draft tag
- edit the release notes. I put new features first, then bug fixes, and I add a "## Dependencies Updates" section listing dependabot updates
- check "Make this release the latest" and click on "Publish"
- release is done !

There are a few more post release steps which can be done by other people.
packit will automatically create fedora PRs to update gvisor-tap-vsock in the
misc fedora releases. These pull requests need to be approved. After the PRs
are approved, packit will create the corresponding updates in bodhi:
https://bodhi.fedoraproject.org/updates/?packages=gvisor-tap-vsock

It's also good to create a podman PR to update gvisor-tap-vsock. These 3 files
Copy link
Member

Choose a reason for hiding this comment

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

future thought. have a GH action do this for you automatically on merge ?

need to be changed: `go.mod: github.com/containers/gvisor-tap-vsock v0.8.0`,
`Makefile:GV_VERSION=v0.8.0` and `contrib/pkginstaller/Makefile:GVPROXY_VERSION ?= 0.8.0`.
Loading