mirror of
				https://github.com/kata-containers/kata-containers.git
				synced 2025-10-30 17:03:57 +00:00 
			
		
		
		
	docs: fix release process doc
We no longer build OBS packages. And we use kata-containers/tools/packaging/release to do release. Signed-off-by: Peng Tao <bergwolf@hyper.sh>
This commit is contained in:
		| @@ -10,7 +10,6 @@ | ||||
|     - [Merge all bump version Pull requests](#merge-all-bump-version-pull-requests) | ||||
|     - [Tag all Kata repositories](#tag-all-kata-repositories) | ||||
|     - [Check Git-hub Actions](#check-git-hub-actions) | ||||
|     - [Create OBS Packages](#create-obs-packages) | ||||
|     - [Create release notes](#create-release-notes) | ||||
|     - [Announce the release](#announce-the-release) | ||||
| <!-- TOC END --> | ||||
| @@ -42,7 +41,7 @@ | ||||
|  | ||||
|   Alternatively, you can also bump the repositories using a script in the Kata packaging repo | ||||
|   ``` | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/packaging/release | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/kata-containers/tools/packaging/release | ||||
|   $ export NEW_VERSION=<the-new-kata-version> | ||||
|   $ export BRANCH=<the-branch-you-want-to-bump> | ||||
|   $ ./update-repository-version.sh -p "$NEW_VERSION" "$BRANCH" | ||||
| @@ -59,7 +58,7 @@ | ||||
|   Once all the pull requests to bump versions in all Kata repositories are merged, | ||||
|   tag all the repositories as shown below.   | ||||
|   ``` | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/packaging/release | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/kata-containers/tools/packaging/release | ||||
|   $ git checkout  <kata-branch-to-release> | ||||
|   $ git pull | ||||
|   $ ./tag_repos.sh -p -b "$BRANCH" tag | ||||
| @@ -71,33 +70,6 @@ | ||||
|  | ||||
|   Check the [actions status page](https://github.com/kata-containers/kata-containers/actions) to verify all steps in the actions workflow have completed successfully. On success, a static tarball containing Kata release artifacts will be uploaded to the [Release page](https://github.com/kata-containers/kata-containers/releases). | ||||
|  | ||||
| ### Create OBS Packages | ||||
|  | ||||
|   - We have set up an [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) job | ||||
|   to trigger generation of Kata packages in [OBS](https://build.opensuse.org/). | ||||
|   Go to the [Azure Pipelines job that creates OBS packages](https://dev.azure.com/kata-containers/release-process/_release?_a=releases&view=mine&definitionId=1). | ||||
|   - Click on "Create release" (blue button, at top right corner). | ||||
|     It should prompt you for variables to be passed to the release job. They should look like: | ||||
|  | ||||
|     ``` | ||||
|     BRANCH="the-kata-branch-that-is-release" | ||||
|     BUILD_HEAD=false | ||||
|     OBS_BRANCH="the-kata-branch-that-is-release" | ||||
|     ``` | ||||
|     Note: If the release is `Alpha` , `Beta` , or `RC` (that is part of a `master` release), please use `OBS_BRANCH=master`. | ||||
|  | ||||
|     The above step shall create OBS packages for Kata for various distributions that Kata supports and test them as well. | ||||
|   - Verify that the packages have built successfully by checking the [Kata OBS  project page](https://build.opensuse.org/project/subprojects/home:katacontainers). | ||||
|   - Make sure packages work correctly. This can be done manually or via the [package testing pipeline](http://jenkins.katacontainers.io/job/package-release-testing). | ||||
|     You have to make sure the packages are already published by OBS before this step. | ||||
|     It should prompt you for variables to be passed to the pipeline: | ||||
|  | ||||
|     ``` | ||||
|     BRANCH="<kata-branch-to-release>" | ||||
|     NEW_VERSION=<the-version-you-expect-to-be-packaged|latest> | ||||
|     ``` | ||||
|     Note: `latest` will verify that a package provides the latest Kata tag in that branch. | ||||
|  | ||||
| ### Create release notes | ||||
|  | ||||
|   We have a script in place in the packaging repository to create release notes that include a short-log of the commits across Kata components. | ||||
| @@ -105,12 +77,12 @@ | ||||
|   Run the script as shown below: | ||||
|  | ||||
|   ``` | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/packaging/release | ||||
|   $ cd ${GOPATH}/src/github.com/kata-containers/kata-containers/tools/packaging/release | ||||
|   # Note: OLD_VERSION is where the script should start to get changes. | ||||
|   $ ./runtime-release-notes.sh ${OLD_VERSION} ${NEW_VERSION} > notes.md | ||||
|   # Edit the `notes.md` file to review and make any changes to the release notes. | ||||
|   # Add the release notes in GitHub runtime. | ||||
|   $ hub -C "${GOPATH}/src/github.com/kata-containers/runtime" release edit -F notes.md "${NEW_VERSION}" | ||||
|   $ hub release edit -F notes.md "${NEW_VERSION}" | ||||
|   ``` | ||||
|  | ||||
| ### Announce the release | ||||
|   | ||||
		Reference in New Issue
	
	Block a user