From fdd3854274d12c537c4272ea30a10eeb2c47d404 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 22 Jun 2016 13:52:30 -0400 Subject: [PATCH] start a readme describing the release tools Start a readme with descriptions and examples of how the release-tools scripts work. Change-Id: I07ad8e2b707df89b46594c6691c9c5c2e551a51e Signed-off-by: Doug Hellmann --- jenkins/scripts/release-tools/README.rst | 60 ++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 jenkins/scripts/release-tools/README.rst diff --git a/jenkins/scripts/release-tools/README.rst b/jenkins/scripts/release-tools/README.rst new file mode 100644 index 0000000000..8b1aaa41b2 --- /dev/null +++ b/jenkins/scripts/release-tools/README.rst @@ -0,0 +1,60 @@ +=============== + Release Tools +=============== + +release_from_yaml.sh +==================== + +This script takes YAML files describing deliverables to release (like those +living in ``openstack/releases``) and calls the release.sh script (see below) +to apply the corresponding tags. It will create a tag for the last release +mentioned in the file(s). You can point it to specific YAML files, or to a +local git repository (in which case it will look at the files modified in the +most recent commit). + +Examples: + +:: + + ./release_from_yaml.sh ../openstack-releases deliverables/mitaka/nova.yaml + +Call release.sh for all repositories mentioned in the last release added +to ../openstack-releases/deliverables/mitaka/nova.yaml + +:: + + ./release_from_yaml.sh ../openstack-releases + +Look into the git repository at ../openstack-releases for deliverable YAML +files modified at the last commit, and call release.sh for all repositories +mentioned on the last release in each such file. + + +release.sh +========== + +This script creates a tag on a given repository SHA and pushes it to Gerrit. +Additionally it will add a message on Launchpad bugs that are mentioned as +"closed" in git commit messages since the last tag on the same series. + +Example: + +:: + + ./release.sh openstack/oslo.rootwrap mitaka 3.0.3 gerrit/master + +Apply a 3.0.3 tag (associated to the mitaka series) to the gerrit master +HEAD of the openstack/oslo.rootwrap reporitory, and add a comment for each +closed bug mentioned in commit messages since the previous mitaka tag (3.0.2). + +branch_from_yaml.sh +=================== + +This script looks at the deliverable files to decide how to create +stable branches. + +:: + + $ branch_from_yaml.sh ~/repos/openstack/releases mitaka + $ branch_from_yaml.sh ~/repos/openstack/releases mitaka + $ branch_from_yaml.sh ~/repos/openstack/releases mitaka deliverables/_independent/openstack-ansible.yaml