Skip to content

Commit

Permalink
Clarify release process (#1202)
Browse files Browse the repository at this point in the history
  • Loading branch information
agcapps committed Nov 17, 2023
1 parent 35ae725 commit f511a25
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/docs/sphinx/dev_guide/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ release changes can be reviewed. Such changes include:
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Merge the release candidate branch into the main branch once it is ready and
approved. At this point, the release candidate branch can be deleted.
approved. Do not "squash merge:" that will make the histories of main and
release branches disagree, and we want to preserve the history. After
merging, the release candidate branch can be deleted.


4: Draft a Github Release
Expand Down Expand Up @@ -120,8 +122,9 @@ approved. At this point, the release candidate branch can be deleted.
^^^^^^^^^^^^^^^^^^^^^^^^^^

* Checkout the main branch locally and run ``axom/scripts/make_release_tarball.sh --with-data``
This will generate a two tarballs of the form ``Axom-v0.3.1.tar.gz`` and ``AxomData-v0.3.1.tar.gz``
each consistsing of the axom source and data respectively.
Run this script from the top level ``axom`` subdirectory. This will
generate a two tarballs of the form ``Axom-v0.3.1.tar.gz`` and ``AxomData-v0.3.1.tar.gz``
consisting of the axom source and data respectively.

* Upload the tarballs for the corresponding release, by going to the
`Github Releases section <https://github.com/LLNL/axom/releases>`_ and ``Edit``
Expand Down

0 comments on commit f511a25

Please sign in to comment.