Doc/capps2/release edits #1202
Merged
Doc/capps2/release edits #1202
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agcapps
added
Release
|
I meant to have this up some weeks ago, but apparently I forgot. Sorry about that. |
bmhan12
approved these changes
Oct 19, 2023
rhornung67
reviewed
Oct 21, 2023
| @@ -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 | |||
rhornung67
reviewed
Oct 21, 2023
| @@ -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 | |||
rhornung67
approved these changes
Oct 21, 2023
kennyweiss
approved these changes
Oct 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the documentation of the release process.
Don't squash merge! And make sure to run
make_release_tarball.shfrom the top level directory.