Skip to content

Commit

Permalink
docs: Improve release README
Browse files Browse the repository at this point in the history
Added backticks to commands and added a TOC.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
  • Loading branch information
jodh-intel committed May 17, 2019
1 parent e8ba16e commit 4213fcb
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions release/README.md
@@ -1,8 +1,15 @@
# 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.

## update-repository-version.sh
## `update-repository-version.sh`

This script creates a GitHub pull request (a.k.a PR) to change the version in
all the Kata repositories.
Expand All @@ -24,12 +31,12 @@ To update all versions for all projects, use the following:
$ make bump-kata-version NEW_VERSION=<new-version>
```

The makefile target bump-kata-version creates a GitHub pull request in the Kata
repositories. These pull requests are tested by the Kata CI to ensure the
The makefile target `bump-kata-version` creates a GitHub pull request in 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
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
tagged.
Expand Down

0 comments on commit 4213fcb

Please sign in to comment.