docs: Document release process - tools. #209

jcvenegas · 2018-10-02T16:06:17Z

Document flow to create a release based in the tools
from this repository.

Fixes: #207

grahamwhaley

This is looking pretty good. I learnt a lot, and it looks nicely scripted.
Most feedback is stylistic and wording.
I'm thinking @klynnrif and @intelkevinputnam will have some feedback.

release/release.md

grahamwhaley · 2018-10-02T18:19:47Z

release/release.md

+
+https://github.com/kata-containers/documentation/blob/master/Release-Checklist.md
+
+In order to simplify the process of do the Release Checklist we have semi-automated most of the process.


s/In order to simplify the process of do the Release Checklist/To simplify the Release Checklist process/

release/release.md

grahamwhaley · 2018-10-02T18:21:27Z

release/release.md

+  ```
+  - OBS account with permissions on /home:katacontainers (https://build.opensuse.org/project/subprojects/home:katacontainers)
+
+  - Github permissions to push tags an creates Releases in Kata repositories.


s/an creates Releases/and create Releases/

release/release.md

grahamwhaley · 2018-10-02T18:24:03Z

release/release.md

+The commands from above will create a github pull request in the Kata projects.
+Work with the Kata approvers to verify that the CI works and the PR are merged.
+
+2. Create Github tags


Just a note - you can use '1' over and over again in a number list and it should sequentially number itself. This helps a lot later on if you need to add or delete an entry, as all entries are labelled '1' in the source.

I tried but I did not work, I wonder if gihub does not detect for the different paragraphs between list.

grahamwhaley · 2018-10-02T18:26:18Z

release/release.md

+
+```bash
+cd ${GOPATH}/src/github.com/kata-containers/packaging/obs-packaging
+#./create-pkg-branch.sh ${BRANCH}


Is the commented out line intentional? If so, please document :-)

Fixed, yes is optional depending if is a new stable branch.

grahamwhaley · 2018-10-02T18:27:01Z

release/release.md

+7. Create release notes.
+```bash
+cd ${GOPATH}/src/github.com/kata-containers/packaging/release
+./runtime-release-notes.sh 1.2.0 1.2.1 > notes.md


Presumably these version numbers will change ;-) - can we script that with ENV vars, or make a comment note that these need setting appropriately etc.

Agree added ENV Var and information about it.

grahamwhaley · 2018-10-02T18:27:56Z

release/release.md

+cd ${GOPATH}/src/github.com/kata-containers/packaging/release
+./runtime-release-notes.sh 1.2.0 1.2.1 > notes.md
+```
+Add release notes in github runtime.


I'm guessing this 'add release notes' is not scripted - in which case can we expand it. It also feels like it should have its own number point section ?

Added a hub command to push new release notes.

jodh-intel

Thanks for putting this together @jcvenegas!

@bergwolf - could you take a look when you are back off holidays as I'm sure you will have input? :)

jodh-intel · 2018-10-03T08:10:51Z

release/release.md

+
+So lets get started.
+
+## Requeriments 


Typo: "Requirements".

I think it would be useful to state somewhere whether it is "safe" to run this process on any machine - does it create all assets, etc in a sub-directory or is it going to modify the entire system? Related to this, are there any particular space requirements for running the process?

Testing: Is it possible to do a "test run" / "dry run" of some/all of these steps?

Problems: Related to the above, I think it would be worth stating somewhere whether particular steps can be repeated safely or not. Imagine you started running through the process and your machine died / ran of out space / etc. How easy is it to recover from those sorts of issues?

Yeah, it is safe to use in your system, most of the task are done in containers.

I'd love to add some tests for the steps, as last release we broken some of this scripts.

I have an azure pipeline to create static tarballs from master @chavafg I am not sure if is fine to add it, we depend all our jobs in jenkins, but was really easy to use.

Added a note that the steps can be repeated in case something fails, not needed to start over.

release/release.md

klynnrif

Scrubbed for grammar, structure, and flow. Hopefully I haven't changed the meaning on anything :) Thanks!

klynnrif · 2018-10-03T16:00:48Z

release/release.md

@@ -0,0 +1,112 @@
+# How to do a Kata Containers Release
+
+Hi if you are reading this document you may also want to create a kata Containers Release.


If you are reading this document, you might want to create a Kata Containers Release.

klynnrif · 2018-10-03T16:45:55Z

release/release.md

+
+https://github.com/kata-containers/documentation/blob/master/Releases.md
+
+To simply the process of read each release we have created a checklist for it.


My two cents :) Lines 5-9:
The Kata Containers Release Process is defined in the following documents:
https://github.com/kata-containers/documentation/blob/master/Releases.md
To simplify this process, we have created a Release Checklist.

Looks better and I combined to add markdown links to make more easy to read.

klynnrif · 2018-10-03T16:47:41Z

release/release.md

+
+https://github.com/kata-containers/documentation/blob/master/Release-Checklist.md
+
+In order to simplify the process of do the Release Checklist we have semi-automated most of the process.


Adding on to @grahamwhaley's suggestion:
To simplify the Release Checklist process we have automated most of the process.

klynnrif · 2018-10-03T16:48:04Z

release/release.md

+
+In order to simplify the process of do the Release Checklist we have semi-automated most of the process.
+
+So lets get started.


I suggest removing this line.

klynnrif · 2018-10-03T16:49:25Z

release/release.md

+- Go (https://golang.org/doc/install#)
+
+- hub (https://github.com/github/hub)
+  If you are using github 2FA, configure hub manually creating a file `~/.config/hub`


github => GitHub + rewrite: If you use GitHub 2FA, configure the hub manually to create a file ~/.config/hub

klynnrif · 2018-10-03T16:57:40Z

release/release.md

+PUSH=1 OBS_SUBPROJECT="releases:$(uname -m):${BRANCH}" ./build_from_docker.sh ${NEW_VERSION}
+```
+
+7. Create release notes.


Same comment regarding period vs colon here.

I added colon to all numbered items.

side note - in markdown (or github markdown at least), if you label your number list as all '1.'s, then it auto-numbers them - which later makes it easier to insert/delete items. Here is an example...

one

another one

a third one

release/release.md

jodh-intel · 2018-10-09T15:15:39Z

Ping @jcvenegas :)

caoruidong · 2018-11-05T02:45:57Z

Ping @jcvenegas

sboeuf · 2018-11-13T19:23:12Z

@jcvenegas what's the status here? Any chance you could rework this PR?

raravena80 · 2018-11-21T05:08:59Z

@jcvenegas ping (from your weekly Kata herder)

jodh-intel · 2018-11-26T12:06:44Z

Ping @jcvenegas

jodh-intel · 2018-12-03T11:53:16Z

🔔 pingle bells, pingle bells... 🔔 @jcvenegas

jodh-intel · 2019-01-07T11:12:15Z

@jcvenegas - could you tal at applying the review feedback here please?

jodh-intel · 2019-01-24T14:35:27Z

Hi @jcvenegas - please could you tal at the feedback? I think this is an important PR which I'd really like to see landed.

amshinde · 2019-01-25T23:04:36Z

ping @jcvenegas

jcvenegas · 2019-02-05T22:25:40Z

Very late update, added fixes suggested thanks all, ready for a second review (I promise to fix them in 4 months)

jodh-intel

Thanks for updating @jcvenegas! I've got a few questions. Also, it would be great to get input from @bergwolf when he's back.

jodh-intel · 2019-02-06T09:24:36Z

release/release.md

+- [Go](https://golang.org/doc/install#)
+
+- [hub](https://github.com/github/hub)
+  If you use GitHub 2FA, configure the hub manually to create a file ~/.config/hub


... configure hub by creating file ~/.config/hub:

Since this contains a secret, we should probably recommend users set strict perms on it:

$ chmod 400 ~/.config/hub

Removed, I've seen that now supports ask for 2 step code, not needed to do this manually again. I just tested and is working.

jodh-intel · 2019-02-06T09:28:49Z

release/release.md

+  ```
+- OBS account with permissions on /home:katacontainers (https://build.opensuse.org/project/subprojects/home:katacontainers)
+
+- GitHub permissions to push tags and creates Releases in Kata repositories.


Do you need to be a github project "owner" for that? I suspect so. Might be worth stating if so.

I am not sure about it, I think we need a group with push tag permissions, @jodh-intel can we create one for this? lets name it "release" if is possible to limit only to push tags better :)

I'm not sure how to create a group that only has tag perms. Anyone else?

I'm not sure you can. The groups don't have a very fine grained perm setting iirc. The tokens have a finer grain, but still not that fine grained I think.

jodh-intel · 2019-02-06T09:29:32Z

release/release.md

+  oauth_token: TOKEN
+  protocol: https
+  ```
+- OBS account with permissions on /home:katacontainers (https://build.opensuse.org/project/subprojects/home:katacontainers)


@marcov - is there a way to describe these OBS permissions briefly do you know? I personally find the OBS website pretty difficult to use.

An account on https://build.opensuse.org with maintainer rights for the home:katacontainers project. Maintainer rights can be asked with the "Request Role Addition" link in the project homepage.

jodh-intel · 2019-02-06T09:30:30Z

release/release.md

+  $ ./update-repository-version.sh -p shim "$NEW_VERSION" "$BRANCH"
+  $ ./update-repository-version.sh -p runtime "$NEW_VERSION" "$BRANCH"
+  $ ./update-repository-version.sh -p osbuilder "$NEW_VERSION" "$BRANCH"
+  $ ./update-repository-version.sh -p agent "$NEW_VERSION" "$BRANCH"


What about the tests repo?

We dont have a control VERSION file for some repositories, like tests they are tagged with the version that was used to test kata but not versioned.

Added a note to make it clear

jodh-intel · 2019-02-06T09:33:16Z

release/release.md

+
+7. Announce release:
+
+  Publish in Slack and Kata mailing list (kata-dev@lists.katacontainers.io) that new release is ready.


Could you remove the mailing list address here and instead add a link to https://github.com/kata-containers/community#join-us? That avoids duplication and also contains the details of the slack channel.

release/release.md

jodh-intel · 2019-02-06T09:39:11Z

release/release.md

+
+## Release process
+
+The steps described here are safe to repeat more than one time, it is safe to


I'd consider making all of this into a multi-bullet note to make it stand out:

Notes::

The steps described here are safe to repeat more than once: it is safe to repeat them in case of unexpected issues, and it is not necessary to start from the beginning.

It is safe to run this process on any machine. It creates all assets in sub-directories and should not modify the entire system.

jodh-intel · 2019-02-06T17:37:48Z

release/release.md

+- You should configure your GitHub to use your ssh keys (to push to branches). See https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/.
+    * As an alternative, configure hub to push and fork with https, `git config --global hub.protocol https` (Not tested yet) *
+
+- [Docker](https://docs.docker.com/install/)


OOI, why is docker needed to perform a release?

yes, some tools use docker to build assets

release/release.md

egernst

It looks good to me, and is a great starting point. I imagine the process will continue to be refined, and the docs will need to be updated accordingly. Thanks @jcvenegas

Document flow to create a release based in the tools from this repository. Fixes: kata-containers#207 Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>

jcvenegas · 2019-02-13T22:07:06Z

/test

jcvenegas · 2019-02-13T22:07:25Z

@jodh-intel ready to merge

grahamwhaley

with all the reviews this has had...
lgtm

rootfs: Bump golang version to 1.11.1

grahamwhaley reviewed Oct 2, 2018

View reviewed changes

jodh-intel reviewed Oct 3, 2018

View reviewed changes

klynnrif suggested changes Oct 3, 2018

View reviewed changes

jodh-intel added the medium-priority Urgent issue (resolve before unprioritised issues) label Jan 24, 2019

jcvenegas closed this Feb 5, 2019

jcvenegas deleted the release-process-md branch February 5, 2019 20:42

jcvenegas restored the release-process-md branch February 5, 2019 20:44

jcvenegas reopened this Feb 5, 2019

jcvenegas force-pushed the release-process-md branch 11 times, most recently from d77ef11 to 0cad671 Compare February 5, 2019 22:16

jodh-intel reviewed Feb 6, 2019

View reviewed changes

jcvenegas force-pushed the release-process-md branch from 0cad671 to c320d56 Compare February 6, 2019 17:29

jodh-intel reviewed Feb 6, 2019

View reviewed changes

release/release.md Outdated Show resolved Hide resolved

jodh-intel reviewed Feb 7, 2019

View reviewed changes

release/release.md Outdated Show resolved Hide resolved

egernst previously approved these changes Feb 11, 2019

View reviewed changes

docs: Document release process - tools.

d0879d7

Document flow to create a release based in the tools from this repository. Fixes: kata-containers#207 Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>

jcvenegas dismissed egernst’s stale review via d0879d7 February 13, 2019 21:58

jcvenegas force-pushed the release-process-md branch from c320d56 to d0879d7 Compare February 13, 2019 21:58

grahamwhaley approved these changes Feb 14, 2019

View reviewed changes

devimc approved these changes Feb 14, 2019

View reviewed changes

devimc merged commit 2b382fd into kata-containers:master Feb 14, 2019

jcvenegas added a commit that referenced this pull request Jul 2, 2019

Merge pull request #209 from marcov/golang-bump

08d52c5

rootfs: Bump golang version to 1.11.1


		https://github.com/kata-containers/documentation/blob/master/Release-Checklist.md

		In order to simplify the process of do the Release Checklist we have semi-automated most of the process.

		@@ -0,0 +1,112 @@
		# How to do a Kata Containers Release

		Hi if you are reading this document you may also want to create a kata Containers Release.


		https://github.com/kata-containers/documentation/blob/master/Releases.md

		To simply the process of read each release we have created a checklist for it.


		In order to simplify the process of do the Release Checklist we have semi-automated most of the process.

		So lets get started.


		7. Announce release:

		Publish in Slack and Kata mailing list (kata-dev@lists.katacontainers.io) that new release is ready.


		## Release process

		The steps described here are safe to repeat more than one time, it is safe to

docs: Document release process - tools. #209

docs: Document release process - tools. #209

Conversation

jcvenegas commented Oct 2, 2018

grahamwhaley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcvenegas Feb 5, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jodh-intel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

klynnrif left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jodh-intel commented Oct 9, 2018

caoruidong commented Nov 5, 2018

sboeuf commented Nov 13, 2018

raravena80 commented Nov 21, 2018

jodh-intel commented Nov 26, 2018

jodh-intel commented Dec 3, 2018

jodh-intel commented Jan 7, 2019

jodh-intel commented Jan 24, 2019

amshinde commented Jan 25, 2019

jcvenegas commented Feb 5, 2019

jodh-intel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

egernst left a comment

Choose a reason for hiding this comment

jcvenegas commented Feb 13, 2019

jcvenegas commented Feb 13, 2019

grahamwhaley left a comment

Choose a reason for hiding this comment

jcvenegas Feb 5, 2019 •

edited

Loading