github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-01 15:57:20 +00:00
Code Issues Projects Releases Wiki Activity

releases: Adjust documentation to the new workflow

Browse Source 
This drops the documentation of the legacy release scripts and adds
a quick description of the scripts of the new workflow. It also
highlights the bump of the `VERSION` file.

Signed-off-by: Greg Kurz <groug@kaod.org>
This commit is contained in:
Greg Kurz 2024-03-18 12:00:22 +01:00
parent 76c640767e
commit 3cfc1b6ba7
2 changed files with 12 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Release-Process.md
View File

@ -7,6 +7,11 @@ This document lists the tasks required to create a Kata Release.
## Release Process
### Bump the `VERSION` file
When the `kata-containers/kata-containers` repository is ready for a new release,
first create a PR to set the release in the `VERSION` file and have it merged.
### Check GitHub Actions
We make use of [GitHub actions](https://github.com/features/actions) in the

37
tools/packaging/release/README.md
View File

@ -11,36 +11,13 @@ See [the release documentation](../../../docs/Release-Process.md).
## Release tools
### `update-repository-version.sh`
### `release.sh`
This script creates a GitHub pull request (a.k.a PR) to change the version in
the Kata repository.
This script is used by [GitHub actions](https://github.com/features/actions) in the
[release](https://github.com/kata-containers/kata-containers/actions/workflows/release.yaml)
file from the `kata-containers/kata-containers` repository to handle the various steps of
the release process.
For more information on using the script, run the following:
### `generate_vendor.sh`
```bash
$ ./update-repository-version.sh -h
```
### Update Kata projects to a new version
To update project version for Kata Containers, use the following:
```bash
# Set to the required version
$ new_version="a.b.c"
$ make bump-kata-version NEW_VERSION="${new_version}"
```
The makefile target `bump-kata-version` creates a GitHub pull request in the
kata-containers repository. The pull request is tested by the Kata CI to ensure the
entire project is working prior to the release. Next, the PR is approved and
merged by Kata Containers members.
### `tag_repos.sh`
After Kata Containers repository is updated with a new version, it needs to be
tagged.
The `tag_repos.sh` script is used to create tags for the Kata Containers repository.
The script creates an **annotated tag** for the new release version.
This script is used by `release.sh` to generate a tarball with all the cargo vendored code.