zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs on point releases (#17463)

Browse Source
This commit is contained in:
Greg Becker 2020-07-11 16:35:25 -05:00 committed by GitHub
parent 73f02b10de
commit 406596af70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
lib/spack/docs/developer_guide.rst
View File

@ -799,19 +799,38 @@ Publishing a release on GitHub
.. _merging-releases: .. _merging-releases:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Updating `develop` and `releases/latest` Updating `releases/latest` and `develop`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
We merge each release into ``develop``, we tag the latest release as If the new release is the **highest** Spack release yet, you should
``releases/latest``. also tag it as ``releases/latest``. For example, suppose the highest
release is currently ``0.15.3``:
#. Once each release is complete, make sure that it is merged back into * If you are releasing ``0.15.4`` or ``0.16.0``, then you should tag
``develop`` with a merge commit: it with ``releases/latest``, as these are higher than ``0.15.3``.
* If you are making a new release of an **older** major version of
Spack, e.g. ``0.14.4``, then you should not tag it as
``releases/latest`` (as there are newer major versions).
To tag ``releases/latest``, do this:
.. code-block:: console
$ git checkout releases/vX.Y # vX.Y is the new release's branch
$ git tag --force releases/latest
$ git push --tags
The ``--force`` argument makes ``git`` overwrite the existing
``releases/latest`` tag with the new one.
We also merge each release that we tag as ``releases/latest`` into ``develop``.
Make sure to do this with a merge commit:
.. code-block:: console .. code-block:: console
$ git checkout develop $ git checkout develop
$ git merge --no-ff releases/vX.Y # vX.Y is the new release's branch $ git merge --no-ff vX.Y.Z # vX.Y.Z is the new release's tag
$ git push $ git push
We merge back to ``develop`` because it: We merge back to ``develop`` because it:
@ -839,29 +858,6 @@ We merge each release into ``develop``, we tag the latest release as
release and later decide you want to tag some later commit, you'll need release and later decide you want to tag some later commit, you'll need
to merge again. to merge again.
#. If the new release is the **highest** Spack release yet, you should
also tag it as ``releases/latest``. For example, suppose the highest
release is currently ``0.15.3``:
* If you are releasing ``0.15.4`` or ``0.16.0``, then you should tag
it with ``releases/latest``, as these are higher than ``0.15.3``.
* If you are making a new release of an **older** major version of
Spack, e.g. ``0.14.4``, then you should not tag it as
``releases/latest`` (as there are newer major versions).
To tag ``releases/latest``, do this:
.. code-block:: console
$ git checkout releases/vX.Y # vX.Y is the new release's branch
$ git tag --force releases/latest
$ git push --tags
The ``--force`` argument makes ``git`` overwrite the existing
``releases/latest`` tag with the new one.
.. _announcing-releases: .. _announcing-releases:
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^