admin/make-tarball.txt

   1 Instructions to create pretest or release tarballs. -*- coding: utf-8 -*-
   2 -- originally written by Gerd Moellmann, amended by Francesco Potortì
   3    with the initial help of Eli Zaretskii
   4
   5
   6 Steps to take before starting on the first pretest in any release sequence:
   7
   8 0.  The release branch (e.g. emacs-24) should already have been made
   9     and you should use it for all that follows.  Diffs from this
  10     branch should be going to the emacs-diffs mailing list.
  11
  12 1.  Decide on versions of automake and autoconf, and ensure you will
  13     have them available for the duration of the release process.
  14
  15 2.  Consider increasing the value of the variable
  16     `customize-changed-options-previous-release' in cus-edit.el to
  17     refer to a newer version of Emacs.  (This is probably needed only
  18     when preparing the first pretest for a major Emacs release.)
  19     Commit cus-edit.el if changed.
  20
  21 3.  Remove any old pretests from ftp://alpha.gnu.org/gnu/emacs/pretest.
  22     You can use `gnupload --delete' (see below for more gnupload details).
  23
  24 General steps (for each step, check for possible errors):
  25
  26 1.   git pull     # fetch from the repository
  27      git status   # check for locally modified files
  28
  29 2.  Regenerate the etc/AUTHORS file:
  30       M-: (require 'authors) RET
  31       M-x authors RET
  32
  33     If there is an "*Authors Errors*" buffer, address the issues.
  34     If there was a ChangeLog typo, fix it.  If a file was deleted or
  35     renamed, consider adding an appropriate entry to authors-ignored-files,
  36     authors-valid-file-names, or authors-renamed-files-alist.
  37
  38     If necessary, repeat M-x authors after making those changes.
  39     Save the "*Authors*" buffer as etc/AUTHORS.
  40     Check the diff looks reasonable.  Maybe add entries to
  41     authors-ambiguous-files or authors-aliases, and repeat.
  42     Commit any fixes to ChangeLogs or authors.el.
  43
  44 3.  Set the version number (M-x load-file RET admin/admin.el RET, then
  45     M-x set-version RET).  For a release, add released ChangeLog
  46     entries (M-x add-release-logs RET).
  47
  48     For a pretest, start at version .90.  After .99, use .990 (so that
  49     it sorts).
  50
  51     The final pretest should be a release candidate.  Set the version
  52     number to that of the actual release.  Pick a date about a week
  53     from now when you intend to make the release.  Use M-x add-release-logs
  54     to add the ChangeLog entries for that date to the tar file (but
  55     not yet to the repository).  Name the tar file as
  56     emacs-XX.Y-rc1.tar.  If all goes well in the following week, you
  57     can simply rename the file and use it for the actual release.
  58
  59 4.   autoreconf -i -I m4 --force
  60      make bootstrap
  61
  62      make -C etc/refcards
  63      make -C etc/refcards clean
  64
  65 5.  Copy lisp/loaddefs.el to lisp/ldefs-boot.el.
  66
  67     Commit etc/AUTHORS, lisp/ldefs-boot.el, and the files changed
  68     by M-x set-version. For a release, also commit the ChangeLog
  69     files in all directories.
  70
  71     If someone else made a commit between step 1 and now,
  72     you need to repeat from step 4 onwards.  (You can commit the files
  73     from step 2 and 3 earlier to reduce the chance of this.)
  74
  75 6.  ./make-dist --snapshot --no-compress
  76
  77     Check the contents of the new tar with admin/diff-tar-files
  78     against the previous release (if this is the first pretest) or the
  79     previous pretest.  If you did not make the previous pretest
  80     yourself, find it at <ftp://alpha.gnu.org/gnu/emacs/pretest>.
  81     Releases are of course at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
  82
  83     If this is the first pretest of a major release, just comparing
  84     with the previous release may overlook many new files.  You can try
  85     something like `find . | sort' in a clean repository, and compare the
  86     results against the new tar contents.
  87
  88 7.   tar -xf emacs-NEW.tar; cd emacs-NEW
  89      ./configure --prefix=/tmp/emacs && make && make install
  90     Use `script' or M-x compile to save the compilation log in
  91     compile-NEW.log and compare it against an old one.  The easiest way
  92     to do that is to visit the old log in Emacs, change the version
  93     number of the old Emacs to __, do the same with the new log and do
  94     M-x ediff.  Especially check that Info files aren't built, and that
  95     no autotools (autoconf etc) run.
  96
  97 8.  cd EMACS_ROOT_DIR && git tag -a TAG && git push origin tag TAG
  98     TAG is emacs-XX.Y.ZZ for a pretest, emacs-XX.Y for a release.
  99
 100 9. Decide what compression schemes to offer.
 101     For a release, at least gz and xz:
 102       gzip --best -c emacs-NEW.tar > emacs-NEW.tar.gz
 103       xz -c emacs-NEW.tar > emacs-NEW.tar.xz
 104     For pretests, just xz is probably fine (saves bandwidth).
 105
 106     Now you should upload the files to the GNU ftp server.  In order to
 107     do that, you must be registered as an Emacs maintainer and have your
 108     GPG key acknowledged by the ftp people.  For instructions, see
 109     http://www.gnu.org/prep/maintain/html_node/Automated-Upload-Registration.html
 110     The simplest method to upload is to use the gnulib
 111     <http://www.gnu.org/s/gnulib/> script "build-aux/gnupload":
 112
 113     For a pretest:
 114      gnupload [--user your@gpg.key.email] --to alpha.gnu.org:emacs/pretest \
 115        FILE.gz FILE.xz ...
 116
 117     For a release:
 118      gnupload [--user your@gpg.key.email] --to ftp.gnu.org:emacs \
 119        FILE.gz FILE.xz ...
 120
 121     You only need the --user part if you have multiple GPG keys and do
 122     not want to use the default.
 123     Obviously, if you do not have a fast uplink, be prepared for the
 124     upload to take a while.
 125
 126
 127     If you prefer to do it yourself rather than use gnupload:
 128
 129     For each FILE, create a detached GPG binary signature and a
 130     clearsigned directive file like this:
 131
 132      gpg -b FILE
 133      echo directory: emacs/pretest > FILE.directive      (for a pretest)
 134      echo directory: emacs > FILE.directive              (for a release)
 135      gpg --clearsign FILE.directive
 136     Upload by anonymous ftp to ftp://ftp-upload.gnu.org/ the files FILE,
 137     FILE.sig, FILE.directive.asc.
 138     For a release, place the files in the /incoming/ftp directory.
 139     For a pretest, place the files in /incoming/alpha instead, so that
 140     they appear on ftp://alpha.gnu.org/.
 141
 142 10. After five minutes, verify that the files are visible at
 143     ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, or
 144     ftp://ftp.gnu.org/gnu/emacs/ for a release.
 145
 146     Download them and check the signatures.  Check they build.
 147
 148 11. Send an announcement to: emacs-devel, and bcc: info-gnu-emacs@gnu.org.
 149     For a pretest, also bcc: platform-testers@gnu.org.
 150     For a release, also bcc: info-gnu@gnu.org.
 151     (The reason for using bcc: is to make it less likely that people
 152     will followup on the wrong list.)
 153     See the info-gnu-emacs mailing list archives for the form
 154     of past announcements.  The first pretest announcement, and the
 155     release announcement, should have more detail.
 156
 157 12. For a release, update the Emacs homepage emacs.html in the web repository.
 158     Also update history.html, and add the new NEWS file as news/NEWS.xx.y.
 159     Regenerate the html manuals (use make-manuals from admin.el).
 160     If there are new manuals, add appropriate index pages.
 161     Delete any old manual pages that are no longer present.