altos/lisp: Include memory stats for test program
[fw/altos] / Releasing
index a7263c6162306541a206cf620037911c5037ffe4..7a87a48bc4114d63a7774f713ad96abdaf19b158 100644 (file)
--- a/Releasing
+++ b/Releasing
 These are Bdale's notes on how to do a release.
 
-       update the version in configure.ac and commit
+       - make sure build environment is up to date
+               sudo cowbuilder --update
 
-       git tag -a <version>
+       git checkout master
 
-       git-buildpackage --git-ignore-new
+       - update the version in configure.ac if Keith hasn't already
 
-               use --git-ignore-new so trash in checked-out tree doesn't
-               cause the build to fail!
+       - make sure the Google Maps API key is in the build chroot and root
+           (cd ~/altusmetrumllc; git pull)
+           sudo mkdir -p /var/cache/pbuilder/base.cow/opt/google /opt/google
+           sudo cp ~/altusmetrumllc/google-maps-api-key \
+               /var/cache/pbuilder/base.cow/opt/google/maps-api-key
+           sudo ln -sf /home/bdale/altusmetrumllc/google-maps-api-key \
+               /opt/google/maps-api-key
 
-               at this point, we have Debian packages
+       - if this is an x.y release, then:
+               git checkout -b branch-<version>
+
+       - if this is an x.y.z release, then:
+               git checkout branch-<version>           # the x.y parts only
+               - cherry-pick or merge appropriate content from master
+       
+       - make sure there is a doc/release-notes-<version>.inc
+       - make sure that doc/altusmetrum-docinfo.xml has the right copyright 
+         year, and add release to the revision history at the front (release 
+         notes will be pulled in automatically)
+       - make absolutely sure checked-out tree is "clean" 
+       - make absolutely sure the pdclib/ submodule is on the master branch,
+         up to date, and "clean"
+
+        git log > ChangeLog
+       git commit -a
+       git tag -a <version>                    # full x.y.z version
+
+       - make sure .git/gbp.conf set to use branch-<version> as upstream
+
+       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:
+       gbp dch --release --multimaint-merge --new-version=<version>-1 
+
+        git commit -n debian/changelog -m "update changelog for Debian build"
+
+       - if this is a -1 release, then
+               gbp 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
+               gbp 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
+       ./autogen.sh --enable-multi-arch \
+               --with-fat-dir=/home/bdale/web/altusmetrum/AltOS/releases
+       make && make fat
 
                this pushes packages for each platform to web site
 
-       - 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
+       # store a stable copy of ARM binaries for production use
+       cp src/easymega-v1.0/*.elf \
+          src/easymini-v1.0/*.elf \
+          src/telebt-v3.0/*.elf \
+          src/teledongle-v3.0/*.elf \
+          src/telegps-v1.0/*.elf \
+          src/telemega-v1.0/*.elf \
+          src/telemega-v2.0/*.elf \
+          src/telemetrum-v2.0/*.elf \
+          ~/altusmetrumllc/Binaries/
+       cp src/easymega-v1.0/flash-loader/*.elf \
+          src/easymini-v1.0/flash-loader/*.elf \
+          src/telebt-v3.0/flash-loader/*.elf \
+          src/teledongle-v3.0/flash-loader/*.elf \
+          src/telegps-v1.0/flash-loader/*.elf \
+          src/telemega-v1.0/flash-loader/*.elf \
+          src/telemega-v2.0/flash-loader/*.elf \
+          src/telemetrum-v2.0/flash-loader/*.elf \
+          ~/altusmetrumllc/Binaries/loaders/
+       (cd ~/altusmetrumllc ; git add Binaries ; git commit -a) 
+       (cd ~/altusmetrumllc ; git push) 
+
+       - copy the relevant release notes .html file from doc/ to 
+           /home/bdale/web/altusmetrum/AltOS/releases/<rev>
+
+       (cd ~/web/altusmetrum/AltOS/releases/<rev> ; rm *.tar.bz2)
+
+       - create /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>,
+         and move the MicroPeak installers from AltOS/releases to there
+               
+       - create /home/bdale/web/altusmetrum/TeleGPS/releases/<rev>,
+         and move the TeleGPS installers from AltOS/releases to there
+               
+       - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn, 
+         /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>.mdwn, and
+         /home/bdale/web/altusmetrum/TeleGPS/releases/<rev>.mdwn
+
+               - make sure the Windows stuff is like 1-4-1, not 1.4.1!
 
        (cd doc ; make publish)
 
                this pushes fresh documents to the web site
+
+       sudo debian/rules clean
+       git push origin master branch-<version> debian pristine-tar
+       git push --tags
+
+               push commits and leave the build tree in an uncluttered state
+
+Testing before a release
+
+       To verify that a build works, the following need to be checked
+       on each platform:
+
+       1) Install package
+
+       2) Connect TM *and* TD devices. Verify that you can Monitor
+          Flight from the TD and Configure Telemetrum from the TM.
+
+       3) Replay Flight, using your favorite .eeprom file. Check
+          each tab, especially the 'Site Map' tab. Make sure the
+          sound works.
+
+       4) Graph Data. Graph a favorite .eeprom file. Make sure you
+          can zoom in on some region of the graph.