update notes on how to release

[fw/altos] / Releasing

diff --git a/Releasing b/Releasing
index 4d2f8e711c5a39df0c5dd05378c7fd6d54c589e2..1c8bd2a1b61f3525945a0ba0a3f64a02d3527f58 100644 (file)
--- a/Releasing
+++ b/Releasing
@@ -1,37 +1,78 @@
 These are Bdale's notes on how to do a release.
 
-       update the version in configure.ac and commit
-
-       git tag -a <version>
-
-       - make sure checked-out tree is "clean" so git won't complain
-
-       git-buildpackage
-
-               at this point, we have Debian packages
+       git checkout master
+
+       - make sure there is a doc/release-notes-<version>.xsl
+       - make sure that doc/altusmetrum.xsl has the right copyright year,
+         and add release to the revision history at the front (release notes
+         will be pulled in automatically)
+
+       - update the version in configure.ac
+        git log > ChangeLog
+       git commit -a
+
+       - make absolutely sure checked-out tree is "clean" 
+       - make absolutely sure the pdclib/ submodule is on the master branch,
+         up to date, and "clean"
+
+       - if this is an x.y release, then:
+               git checkout -b branch-<version>
+               git tag -a <version>
+               - edit .git/gbp.conf to use branch-<version> as upstream
+
+       - if this is an x.y.z release, then:
+               git checkout branch-<version>           # the x.y parts only
+               git merge master
+               git tag -a <version>                    # full x.y.z version
+
+       git checkout debian
+       git merge branch-<version>
+
+       - verify debian/changelog is "clean" ending in last release version
+       - craft a suitable debian/changelog entry, possibly using:
+       git-dch --release --new-version=<version>-1 --multimaint-merge
+
+        git commit -n debian/changelog -m "update changelog for Debian build"
+
+       - if this is a -1 release, then
+               git-buildpackage --git-no-pristine-tar --git-submodules \
+                       --git-upstream-branch=branch-<version> \ # eg 1.3
+                       --git-upstream-tag=<version>             # eg 1.3.1
+               pristine-tar commit \
+                       ../build-area/altos_<version>.orig.tar.gz \
+                       branch-<version>
+         else if this is not a -1 release
+               git-buildpackage --git-submodules
 
        git tag debian/<version>
 
+       - at this point we have packages in ~/debian/build-area/altos, now
+         we move on to the non-Debian part of the release process
+
        make distclean
 
        ./autogen.sh --with-fat-dir=/home/bdale/web/altusmetrum/AltOS/releases
-       make fat
+       make && make fat
 
                this pushes packages for each platform to web site
 
        - copy the relevant release notes file from doc/ to 
            /home/bdale/web/altusmetrum/AltOS/releases/<rev>
 
-       - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn to include
-         release date and explicit ref to dir contents so the AltOS page
-         shows versioned links, commit and push
+       - create /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>,
+         and move the MicroPeak installers from AltOS/releases to there
+               
+       - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn and 
+         /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>.mdwn, to 
+         include release date and explicit ref to dir contents so the 
+         web pages shows versioned links, commit and push
 
        (cd doc ; make publish)
 
                this pushes fresh documents to the web site
 
        sudo debian/rules clean
-       git push
+       git push origin master branch-<version> debian pristine-tar
        git push --tags
 
                push commits and leave the build tree in an uncluttered state