michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: release: Clarifications to tagging

Browse source 
Clarify a few points in the tagging section of the release
documentation.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-06-09 19:32:19 +02:00 • committed by Carles Cufí
commit b9dcc9b283
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/development_process/release_process.rst
View file

@ -241,7 +241,8 @@ steps:
interface. The GitHub release interface does not generate annotated tags (it interface. The GitHub release interface does not generate annotated tags (it
generates 'lightweight' tags regardless of release or pre-release). You should generates 'lightweight' tags regardless of release or pre-release). You should
also upload your gpg public key to your GitHub account, since the instructions also upload your gpg public key to your GitHub account, since the instructions
below involve creating signed tags. below involve creating signed tags. However, if you do not have a gpg public
key you can opt to remove the ``-s`` option from the commands below.
.. tabs:: .. tabs::
@ -265,7 +266,7 @@ steps:
#. Tag and push the version, using an annotated tag:: #. Tag and push the version, using an annotated tag::
$ git pull $ git pull
$ git tag -m "Zephyr 1.11.0-rc1" -s v1.11.0-rc1 $ git tag -s -m "Zephyr 1.11.0-rc1" v1.11.0-rc1
$ git push git@github.com:zephyrproject-rtos/zephyr.git v1.11.0-rc1 $ git push git@github.com:zephyrproject-rtos/zephyr.git v1.11.0-rc1
#. Create a shortlog of changes between the previous release (use #. Create a shortlog of changes between the previous release (use
@ -274,7 +275,7 @@ steps:
$ git shortlog v1.10.0..v1.11.0-rc1 $ git shortlog v1.10.0..v1.11.0-rc1
#. Find the new tag at the top of the releases page and edit the release #. Find the new tag at the top of the releases page and edit the release
with the ``Draft a new release`` button with the following: with the ``Edit tag`` button with the following:
* Name it ``Zephyr 1.11.0-rc1`` * Name it ``Zephyr 1.11.0-rc1``
* Copy the shortlog into the release notes textbox (*don't forget * Copy the shortlog into the release notes textbox (*don't forget
@ -307,14 +308,17 @@ steps:
#. Tag and push the version, using two annotated tags:: #. Tag and push the version, using two annotated tags::
$ git pull $ git pull
$ git tag -m "Zephyr 1.11.0" -s v1.11.0 $ git tag -s -m "Zephyr 1.11.0" v1.11.0
$ git push git@github.com:zephyrproject-rtos/zephyr.git v1.11.0 $ git push git@github.com:zephyrproject-rtos/zephyr.git v1.11.0
$ git tag -m "Zephyr 1.11.0" -s zephyr-v1.11.0 # This is the tag that will represent the release on GitHub, so that
# the file you can download is named ``zephyr-v1.11.0.zip`` and not
# just ``v1.11.0.zip``
$ git tag -s -m "Zephyr 1.11.0" zephyr-v1.11.0
$ git push git@github.com:zephyrproject-rtos/zephyr.git zephyr-v1.11.0 $ git push git@github.com:zephyrproject-rtos/zephyr.git zephyr-v1.11.0
#. Find the new tag at the top of the releases page and edit the release #. Find the new ``zephyr-v1.11.0`` tag at the top of the releases page
with the ``Draft a new release`` button with the following: and edit the release with the ``Edit tag`` button with the following:
* Name it ``Zephyr 1.11.0`` * Name it ``Zephyr 1.11.0``
* Copy the full content of ``docs/releases/release-notes-1.11.rst`` * Copy the full content of ``docs/releases/release-notes-1.11.rst``