aboutsummaryrefslogtreecommitdiff
path: root/tools/star/release-guide.pod
diff options
context:
space:
mode:
Diffstat (limited to 'tools/star/release-guide.pod')
-rw-r--r--tools/star/release-guide.pod21
1 files changed, 21 insertions, 0 deletions
diff --git a/tools/star/release-guide.pod b/tools/star/release-guide.pod
index b17c111..e15ab48 100644
--- a/tools/star/release-guide.pod
+++ b/tools/star/release-guide.pod
@@ -15,6 +15,16 @@ expect to slow down to quarterly releases again sometime in 2013.
=head2 Steps to create a release
+If this is your first time releasing, B<read the whole guide before
+starting>. That way you can ask questions and clear up and confusions before
+you're in the thick of it.
+
+If you have done this before, you might want to check for and read any changes
+to this release guide since your last run.
+
+Any time this guide tells you to commit changes, you may also push them if you
+wish to do so. Step 8 will make sure you do this regardless.
+
=over 4
=item 1.
@@ -44,6 +54,12 @@ with the needed tarballs and module repositories for building Rakudo Star:
$ make -f tools/star/Makefile
+You may at times be prompted for your SSH key/pass combo.
+
+Assuming the Makefile ran successfully, you should now commit your changes.
+
+ $ git commit tools
+
=item 4.
If there are any new modules to be added, use "git submodule" to add
@@ -77,6 +93,11 @@ to any changes listed in Rakudo's ChangeLog.
$ git add docs/announce/YYYY.MM.md
$ git commit docs
+At this point it is strongly advised that you push your changes so far, to get
+feedback on your announcement while you do other steps.
+
+ $ git push
+
=item 7.
Update the release number in the README and Makefile.in files.