Skip to content
This repository was archived by the owner on Oct 13, 2022. It is now read-only.

Commit c17acda

Browse files
committed
Update the directions to make a release.
1 parent fab38ba commit c17acda

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

docs/MakeRelease.html

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ <h1>Creating a new release</h1>
1515
<li>Make sure there are no outstanding commits or
1616
pull requests that should be in the new release.
1717
<li>Do some testing.
18-
<li>Pick a release number <code>X.Y.Z</code>.
18+
<li>Pick a release number <code>X.Y.Z</code>
19+
where <code>X</code>, <code>Y</code>, and <code>Z</code>
20+
are numbers (no additional characters).
1921
To stay consistent with
2022
<a href='https://semver.org'>Semantic Versioning</a>,
2123
for now stay with <code>X=0</code>.
@@ -26,31 +28,43 @@ <h1>Creating a new release</h1>
2628

2729
<li>In
2830
<code>shasta/.github/workflows/Build.yml</code>,
29-
change the build id to <code>Shasta Release X.Y.Z</code>
30-
in 4 places.
31+
change <code>BUILD_ID</code> to <code>Shasta Release X.Y.Z</code>
32+
in all <code>cmake</code> commands (5 instances at the time of last update of this documentation).
3133
<li>Commit and push this change to trigger a new build on GitHub Actions.
3234
Wait for that build to complete.
3335
<li>Download the 7 artifacts. Unzip them and rename them to the following:
3436
<ul>
3537
<li><code>shasta-Linux-X.Y.Z</code>
3638
<li><code>shasta-OldLinux-X.Y.Z</code>
37-
<li><code>shasta-macOS-X.Y.Z</code>
39+
<li><code>shasta-macOS-10.14-X.Y.Z</code>
40+
<li><code>shasta-macOS-10.15-X.Y.Z</code>
3841
<li><code>shasta-Ubuntu-16.04-X.Y.Z.tar</code>
3942
<li><code>shasta-Ubuntu-18.04-X.Y.Z.tar</code>
43+
<li><code>shasta-Ubuntu-20.04-X.Y.Z.tar</code>
4044
</ul>
4145

42-
<li>Create the release on GitHub and write some release notes.
43-
The release name should be just/simply <code>X.Y.Z</code>.
46+
<li>Create release notes in markdown format.
47+
This is
48+
<a href="https://markdownlivepreview.com/">a web page</a> that can be used to review
49+
the release notes before posting on GitHub.
50+
Just paste the markdown to the left pane.
51+
52+
<li>Create the release on GitHub and paste the release notes.
53+
The release name should be just/simply <code>X.Y.Z</code>
54+
(no additional characters).
55+
The release will not be visible to users until it gets published
56+
two steps below.
4457
<li>Upload the unzipped and renamed artifacts
4558
to the new release as assets.
4659

4760
<li>Publish the release on GitHub.
4861
<li>After the release has been published it should not be modified or deleted.
4962
<li>In
5063
<code>shasta/.github/workflows/Build.yml</code>,
51-
change the build id to
64+
change <code>BUILD_ID</code> to
5265
<code>Shasta unreleased test build newer than release X.Y.Z</code>
53-
in 4 places for future GitHub Actions builds.
66+
in all <code>cmake</code> commands for future GitHub Actions builds
67+
(5 instances at the time of last update of this documentation).
5468
</ul>
5569

5670

0 commit comments

Comments
 (0)