maint.mk: provide a web-manual-update target
[gnulib.git] / top / README-release
index 680547b..e5f0e4d 100644 (file)
@@ -1,6 +1,6 @@
 Here are most of the steps we (maintainers) follow when making a release.
 
-* Start from a clean, up-to-date git directory:
+* Start from a clean, up-to-date git directory on "master":
 
     make -k maintainer-clean || { ./configure && make maintainer-clean; }
     git checkout master
@@ -10,10 +10,10 @@ Here are most of the steps we (maintainers) follow when making a release.
   are in your PATH.  See the buildreq list in bootstrap.conf for
   the complete list of tools.
 
-* Ensure that you're on "master" with no uncommitted diffs.
-  This should produce no output:
+* Ensure that you have no uncommitted diffs.  This should produce no
+  output:
 
-    git checkout master; git diff
+    git diff
 
 * Ensure that you've pushed all changes that belong in the release:
 
@@ -31,11 +31,16 @@ Here are most of the steps we (maintainers) follow when making a release.
 
     make check syntax-check distcheck
 
-* Set the date, version number, and release type [stable/alpha/beta] on
-  line 3 of NEWS, commit that, and tag the release by running e.g.,
+* From top_srcdir, run:
 
     build-aux/do-release-commit-and-tag X.Y stable
 
+  in order to (i) set the date, version number, and release type
+  [stable/alpha/beta] on line 3 of NEWS, (ii) commit that, and (iii) tag the
+  release.  See --help if you need options such as:
+
+    build-aux/do-release-commit-and-tag --branch=maint -C _build X.Y.Z stable
+
 * Run the following to create release tarballs.  Your choice selects the
   corresponding upload-to destination in the emitted gnupload command.
   The different destinations are specified in cfg.mk.  See the definitions
@@ -67,12 +72,15 @@ Once all the builds and tests have passed,
 * Announce it on Savannah first, so you can include the savannah.org
   announcement link in the email message.
 
-  From here:
-    https://savannah.gnu.org/projects/@PACKAGE@/
-  click on "submit news", then write something like the following:
-  (If there is no such button, then enable "News" for the project via
-   the Main -> "Select Features" menu item, or via this link:
-   https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=@PACKAGE@)
+  Go to the news-submission form:
+
+    https://savannah.gnu.org/news/submit.php?group=@PACKAGE@
+
+  If it does not work, then enable "News" for the project via this link:
+
+    https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=@PACKAGE@
+
+  Write something like the following:
 
     Subject: @PACKAGE@-X.Y released [stable]
     +verbatim+
@@ -80,14 +88,15 @@ Once all the builds and tests have passed,
     -verbatim-
 
   Then go here to approve it:
+
     https://savannah.gnu.org/news/approve.php?group=@PACKAGE@
 
 * Send the announcement email message.
 
-* After each non-alpha release, update the on-line manual accessible via
+* After each non-alpha release, run
 
-    http://www.gnu.org/software/@PACKAGE@/manual/
+    make web-manual-update
 
-  by running this:
+  to update the on-line manual accessible at
 
-    build-aux/gnu-web-doc-update
+    http://www.gnu.org/software/@PACKAGE@/manual/