github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-28 16:27:50 +00:00
Code Issues Projects Releases Wiki Activity

release: Fix typos and organization issues

Browse Source 
For better reading, re-orginize the `release/README.md`
and fix a typo in `runtime-release-notes.sh`.

Fixes: #769.

Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
This commit is contained in:
Salvador Fuentes 2019-10-24 14:53:39 -05:00
parent 6bd5fd900c
commit d56dec0475
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
release/README.md
View File

@ -1,20 +1,24 @@
# Release tools # Release information
* [Introduction](#introduction) * [Introduction](#introduction)
* [Create a Kata Containers release](#create-a-kata-containers-release) * [Create a Kata Containers release](#create-a-kata-containers-release)
* [`update-repository-version.sh`](#update-repository-versionsh) * [Release tools](#release-tools)
* [Update Kata projects to a new version](#update-kata-projects-to-a-new-version) - [`update-repository-version.sh`](#update-repository-versionsh)
* [`tag_repos.sh`](#tag_repossh) - [Update Kata projects to a new version](#update-kata-projects-to-a-new-version)
- [`tag_repos.sh`](#tag_repossh)
## Introduction ## Introduction
This directory contains tools for Kata Containers releases. This directory contains information of the process and
tools used for creating Kata Containers releases.
## Create a Kata Containers release ## Create a Kata Containers release
See [the release documentation](release.md). See [the release documentation](release.md).
## `update-repository-version.sh` ## Release tools
### `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.
@ -25,7 +29,7 @@ For more information on using the script, run the following:
$ ./update-repository-version.sh -h $ ./update-repository-version.sh -h
``` ```
## Update Kata projects to a new version ### Update Kata projects to a new version
Kata Containers is divided into multiple projects. With each release, all Kata Containers is divided into multiple projects. With each release, all
project versions are updated to keep the version consistent. project versions are updated to keep the version consistent.
@ -41,7 +45,7 @@ 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.

2
release/release.md
View File

@ -125,7 +125,7 @@ make sure the packages install and work. To help with this you can use the [pack
Publish in [Slack and Kata mailing list][join-us-kata] that new release is ready. Publish in [Slack and Kata mailing list][join-us-kata] that new release is ready.
8. Send changes to upstream. 8. Send changes to upstream.
If you found any issue during the release process and you fix it, please send it back. If you found any issue during the release process and you fixed it, please send it back.
After your changes are merged, tag Kata packaging with `${NEW_VERSION}` to identify the code used for the release. After your changes are merged, tag Kata packaging with `${NEW_VERSION}` to identify the code used for the release.

2
release/runtime-release-notes.sh
View File

@ -72,7 +72,7 @@ get_release_info() {
} }
changes() { changes() {
echo "**FIXME - massage this section by hand to produce a summary please**" echo "**FIXME - message this section by hand to produce a summary please**"
echo "### Shortlog" echo "### Shortlog"
for cr in $(git log --merges "${previous_release}".."${new_release}" | grep 'Merge:' | awk '{print $2".."$3}'); do for cr in $(git log --merges "${previous_release}".."${new_release}" | grep 'Merge:' | awk '{print $2".."$3}'); do