]> git.notmuchmail.org Git - notmuch/blobdiff - RELEASING
create notmuch_show_params_t structure for holding parameters passed to show functions.
[notmuch] / RELEASING
index e438a1d0c2c7735a5766d943aca3b72dfe68dad4..a392d819f9cc8ca2ad262c609c47ffcb2b712fe7 100644 (file)
--- a/RELEASING
+++ b/RELEASING
@@ -13,7 +13,7 @@ repository. From here, there are just a few steps to release:
 
        Read through the entry at the top of the NEWS file and see if
        you are aware of any major features recently added that are
-       not mentioned there. If so, pleas add them, (and ask the
+       not mentioned there. If so, please add them, (and ask the
        authors of the commits to update NEWS in the future).
 
 2) Verify that the library version in lib/Makefile.local is correct
@@ -48,18 +48,18 @@ repository. From here, there are just a few steps to release:
        as "1.1" or "1.2").
 
        Finally, releases that do not change "features" but are merely
-       bug fixes either add increase the micro number or add it
-       (starting at ".1" if not present). So a bug-fix release from
-       "1.0" would be "1.0.1" and a subsequent bug-fix release would
-       be "1.0.2" etc.
+       bug fixes either increase the micro number or add it (starting
+       at ".1" if not present). So a bug-fix release from "1.0" would
+       be "1.0.1" and a subsequent bug-fix release would be "1.0.2"
+       etc.
 
        Commit this change.
 
 4) Create an entry for the new release in debian/changelog
 
        The syntax of this file is tightly restricted, but the
-       available emacs mode (see the dpkg-dev-el package helps).  The
-       entries here will be the Debian-relevant single-line
+       available emacs mode (see the dpkg-dev-el package) helps.
+       The entries here will be the Debian-relevant single-line
        description of changes from the NEWS entry. And the version
        must match the version in the next step.
 
@@ -69,19 +69,28 @@ repository. From here, there are just a few steps to release:
        release, (taking entries from NEWS and the version from the
        version file, and creating a new commit, etc.)
 
-5) Run "make release" which will perform the following steps:
+5) Run "make release" which will perform the following steps.
+
+   Note: If any problem occurs during the process, (such as a lintian
+   warning that you decide should be fixed), you can abort at the
+   prompt for your GPG passphrase and nothing will have been uploaded
+   yet.
 
        * Ensure that the version consists only of digits and periods
+       * Ensure that version and debian/changelog have the same version
        * Verify that the source tree is clean
        * Compile the current notmuch code (aborting release if it fails)
        * Run the notmuch test suite (aborting release if it fails)
-       * Generate the final tar file
+       * Compile a Debian package
+       * Copy the tar file from what was made for Debian package
        * Generate a .sha1 sum file for the tar file
        * Sign the sha1sum using your GPG setup (asks for your GPG password)
        * Check that no release exists with the current version
        * scp the three files to appear on http://notmuchmail.org/releases
        * Create a LATEST-notmuch-version file (after deleting any old one)
-       * Place local copies of the three files in the releases directory
+       * Place local copies of the tar, sha1, and gpg files into releases
+       * Upload the Debian package
+       * Place a local copy of the Debian package files in releases
        * Tag the entire source tree with a tag of the form X.Y.Z, and sign
          the tag with your GPG key (asks for your GPG password, and you
          may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match