18 Making Releases

From time to time, at the project lead’s discretion, a release will be made and tarballs created and made available on the SXEmacs download site.

The decision as to when to cut a release is generally influenced by two factors:

1. How stable the code base is currently.
2. Whether the changes since the last release warrant a new release.

The minimum number of revisions between releases is one. The maximum number of revisions between releases is, well, there is no maximum.

The actual steps involved in cutting a release are:

• Finalise things like...
  • Update etc/NEWS

    To get the numbers for the "Developer Stats" section, first get a list of unique committers for this release with…

    git log --format=full v22.1.16..|grep Author|sort -u

    And then for the number of actual commits for each developer do…

    git log --oneline --no-merges --author=NAME v22.1.16..|wc -l

  • Make sure INSTALL, PROBLEMS etc are up to date.
  • Update sxemacs.texi at…

    It corresponds to: version-string

  • Update the codename and version in autogen.sh
  • Update the versioning macros in this document.
• Commit those updates.

  git commit -sam "SXEmacs v22.1.17 is released!"

• Create a new tag which will be the version number of this release.

  git tag -s v22.1.17 -m "SXEmacs v22.1.17"

• Push it to the public repo.

  git push --tags origin master

• Prepare tarball:

  (in the release working directory)

  git archive --format=tar \
      --prefix=sxemacs-22.1.17/ HEAD | \
      (cd ~/upload && tar xf -)
  

• Clean out the working directory and do autotool preparations.

  HAMMER=1 ./autogen.sh
  

• Copy the autotool files to the exported tree

  cp -va libltdl ~/upload/sxemacs-22.1.17 &&
  for f in $(git ls-files --others -i --exclude-standard); do
      cp -va ${f} ~/upload/sxemacs-22.1.17/${f}
  done
  

• Add a ChangeLog

  git log --stat v22.1.16..v22.1.17 > ~/upload/sxemacs-22.1.17/ChangeLog
  

• Create a diff against the previous version.

      git diff v22.1.16..v22.1.17 > ~/upload/sxemacs-22.1.16-22.1.17.diff
  

• Create the tarballs, md5sums, and sigs:

  cd ~/upload
  for compressor in bzip2 gzip lzma xz; do
      ${compressor} --keep sxemacs-22.1.16-22.1.17.diff
  done &&
  for type in bz2 gz lzma xz; do
      tar --create --owner=0 --group=0 --auto-compress --file \
        sxemacs-22.1.17.tar.${type} sxemacs-22.1.17
      md5sum sxemacs-22.1.17.tar.${type} > \
        sxemacs-22.1.17.tar.${type}.md5
      md5sum sxemacs-22.1.16-22.1.17.diff.${type} > \
        sxemacs-22.1.16-22.1.17.diff.${type}.md5
      gpg --detach-sign --armor --output \
        sxemacs-22.1.17.tar.${type}.asc sxemacs-22.1.17.tar.${type}
      gpg --detach-sign --armor --output \
        sxemacs-22.1.16-22.1.17.diff.${type}.asc \
        sxemacs-22.1.16-22.1.17.diff.${type}
  done
  

• Move the tarballs, diffs, GnuPG sigs, and md5sums to SXEmacs Download Site.

  for file in *.{bz2,gz,lzma,xz,md5,asc}; do
      scp ${file} downloads.sxemacs.org:downloads.sxemacs.org/releases
  done
  

• Rename the LATEST-IS-VER file.

  ssh downloads.sxemacs.org \
    mv downloads.sxemacs.org/releases/LATEST-IS-{22.1.16,22.1.17}
  

• Update www.sxemacs.org:
  • Update download.html
  • Add ChangeLog-22.1.17 to the website
  • Update index.html
• Send a release announcement to SXEmacs Devel and comp.emacs.xemacs.
• Commit the first patch to the next version, which would be adding a ChangeLog.d/ChangeLog-22.1.17