-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document how gvisor-tap-vsock releases are made
Signed-off-by: Christophe Fergeau <[email protected]>
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/v0.8.2/.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 | ||
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`. |