summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Ardeois <cardeois@internap.com>2016-10-12 10:40:44 -0400
committerCorentin Ardeois <cardeois@internap.com>2016-10-12 14:56:00 -0400
commit58a4b79f65b607b3100447e1a6e56b6f9c1d68c5 (patch)
treeef252c826447d012cf0bd36ecd3a819d0d215bd7
parent70a98fb10c06d551cb28101c499458eef8321e0a (diff)
Added documentation for releasing
This patch document the release guilines to publish js-openstack-lib to npm. Change-Id: I54f5ac4b418f057f17f4eaac4e06f72948d1f096
Notes
Notes (review): Code-Review+1: Dong Ma <winterma.dong@gmail.com> Code-Review+2: Vitaly Kramskikh <vkramskikh@mirantis.com> Workflow+1: Vitaly Kramskikh <vkramskikh@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Tue, 18 Oct 2016 12:39:17 +0000 Reviewed-on: https://review.openstack.org/385504 Project: openstack/js-openstack-lib Branch: refs/heads/master
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/releasing.rst26
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 75d0a5d..94c5a67 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,6 +18,7 @@ Topics
18 reference_documentation 18 reference_documentation
19 dev_get_started 19 dev_get_started
20 specs 20 specs
21 releasing
21 22
22 23
23.. _gerrit: https://review.openstack.org/#/q/status:open+AND+project:openstack/js-openstack-lib,n,z 24.. _gerrit: https://review.openstack.org/#/q/status:open+AND+project:openstack/js-openstack-lib,n,z
diff --git a/doc/source/releasing.rst b/doc/source/releasing.rst
new file mode 100644
index 0000000..daca989
--- /dev/null
+++ b/doc/source/releasing.rst
@@ -0,0 +1,26 @@
1===============================
2How to release js-openstack-lib
3===============================
4
5Only follow these steps if you have authority to release a version of js-openstack-lib.
6
71. Ensure that you have gpg set up locally.
8 If you do not currently have gpg installed:
9
10 `brew install gpg gpg2`
11
12 Set up your gpg key:
13
14 https://wiki.openstack.org/wiki/Oslo/ReleaseProcess#Setting_Up_GPG
15
162. `git pull --ff-only`
17
183. `git tag -s <version number>`
19
204. `git push gerrit <version number>`
21
22 Git won’t have a remote named gerrit until the first time git-review runs.
23 You may need to run git review -s before the push.
24
25For more information see:
26http://docs.openstack.org/infra/manual/drivers.html#tagging-a-release