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

docs: Improve release README

Browse Source 
Added backticks to commands and added a TOC.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-05-16 15:05:34 +01:00
parent e8ba16eec9
commit 4213fcba53
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
release/README.md
View File

@ -1,8 +1,15 @@
# Release tools # Release tools
* [Introduction](#introduction)
* [`update-repository-version.sh`](#update-repository-versionsh)
* [Update Kata projects to a new version](#update-kata-projects-to-a-new-version)
* [`tag_repos.sh`](#tag_repossh)
## Introduction
This directory contains tools for Kata Containers releases. This directory contains tools for Kata Containers releases.
## update-repository-version.sh ## `update-repository-version.sh`
This script creates a GitHub pull request (a.k.a PR) to change the version in This script creates a GitHub pull request (a.k.a PR) to change the version in
all the Kata repositories. all the Kata repositories.
@ -24,12 +31,12 @@ To update all versions for all projects, use the following:
$ make bump-kata-version NEW_VERSION=<new-version> $ make bump-kata-version NEW_VERSION=<new-version>
``` ```
The makefile target bump-kata-version creates a GitHub pull request in the Kata The makefile target `bump-kata-version` creates a GitHub pull request in the
repositories. These pull requests are tested by the Kata CI to ensure the Kata repositories. These pull requests are tested by the Kata CI to ensure the
entire project is working prior to the release. Next, the PR is approved and entire project is working prior to the release. Next, the PR is approved and
merged by Kata Containers members. merged by Kata Containers members.
## tag_repos.sh ## `tag_repos.sh`
After all the Kata repositories are updated with a new version, they need to be After all the Kata repositories are updated with a new version, they need to be
tagged. tagged.