summaryrefslogtreecommitdiff
path: root/README-release
diff options
context:
space:
mode:
Diffstat (limited to 'README-release')
-rw-r--r--README-release87
1 files changed, 87 insertions, 0 deletions
diff --git a/README-release b/README-release
new file mode 100644
index 0000000..86a097b
--- /dev/null
+++ b/README-release
@@ -0,0 +1,87 @@
+Here are most of the steps we (maintainers) follow when making a release.
+
+* start from a clean, up-to-date git directory.
+
+ make -k maintainer-clean || { ./configure && make maintainer-clean; }
+ git checkout master
+ git pull origin master
+
+* Ensure that the desired versions of autoconf, automake, etc.
+ are in your PATH. See the buildreq list in bootstrap.conf for
+ the complete list.
+
+* Ensure that you're on "master" with no uncommitted diffs.
+ This should produce no output: git checkout master; git diff
+
+* Ensure that you've pushed all changes that belong in the release
+ and that the NixOS/Hydra autobuilder is reporting all is well:
+
+ http://hydra.nixos.org/jobset/gnu/diffutils-master
+
+* Run "./bootstrap && ./configure". This downloads any new translations:
+
+* Pre-release testing:
+ Ensure that "make check syntax-check" succeeds.
+
+* Run "make 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.,
+
+ build-aux/do-release-commit-and-tag X.Y 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
+ of gnu_ftp_host-{alpha,beta,stable}.
+
+ # "TYPE" must be stable, beta or alpha
+ make TYPE
+
+* Test the tarball. Copy it to a few odd-ball systems and ensure that
+ it builds and passes all tests.
+
+* While that's happening, write the release announcement that you will
+ soon post. Start with the template, $HOME/announce-diffutils-X.Y
+ that was just created by that "make" command.
+
+Once all the builds and tests have passed,
+
+* Run the gnupload command that was suggested by your "make stable" run above.
+
+* Wait a few minutes (maybe up to 30?) and then use the release URLs to
+ download all tarball/signature pairs and use gpg --verify to ensure
+ that they're all valid.
+
+* Push the NEWS-updating changes and the new tag:
+
+ v=$(cat .prev-version)
+ git push origin master tag v$v
+
+* Announce it on Savannah first, so you can include the preferable
+ savannah.org announcement link in the email message.
+
+ From here:
+ https://savannah.gnu.org/projects/diffutils/
+ click on the "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=diffutils)
+
+ Subject: diffutils-X.Y released [stable]
+ +verbatim+
+ ...paste the announcement here...
+ -verbatim-
+
+ Then go here to approve it:
+ https://savannah.gnu.org/news/approve.php?group=diffutils
+
+* Send the announcement email message.
+
+* After each non-alpha release, update the on-line manual accessible via
+
+ http://www.gnu.org/software/diffutils/manual/
+
+ by running this:
+
+ build-aux/gnu-web-doc-update