altos/test: Adjust CRC error rate after FEC fix
[fw/altos] / Releasing
index a20b6dc084e0d461eafb68422e0917ca6bdc48ac..9750a4eb3a32b9cc19ee6f23491169985ed2f756 100644 (file)
--- a/Releasing
+++ b/Releasing
@@ -3,6 +3,8 @@ Adding a product to the release
        Make sure the firmware and loader get built by default in
        src/Makefile
 
+       Add firmware targets to fat_altos target in Makefile.am
+       
        Add the firmware to altosui/Makefile.am
 
        Add the firmware to altosui/altos-windows.nsi.in
@@ -17,6 +19,8 @@ These are Keith's notes on how to do a release
 
        - update the version and date in configure.ac if Bdale hasn't already
 
+       - update the ANDROID_VERSION in configure.ac if releasing AltosDroid
+
        - follow instructions in doc/RELNOTES
 
        - make sure there is a doc/release-notes-<version>.inc
@@ -25,22 +29,29 @@ These are Keith's notes on how to do a release
 
        - make sure doc/Makefile points at that too
 
-       - 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 by release-notes.inc)
+       - confirm doc/header.inc has correct copyright year
+
 
 These are Bdale's notes on how to do a release.
 
-       - make sure build environment is up to date
+       - make sure Debian build environment is up to date
                sudo cowbuilder --update
 
+       - make sure fat build environment is up to date
+               sudo apt update && sudo apt upgrade && sudo apt autoremove
+
        - ensure i386 build support is available, and we have tools to build
          installers for Windows and Mac OS X
 
-               sudo dpkg --add-architecture i386
                sudo apt update
-               sudo apt install gcc-multilib genisoimage nsis
-               (need some mingw packages too, but not sure which offhand)
+               sudo apt install genisoimage nsis \
+                       gcc-i686-linux-gnu gcc-aarch64-linux-gnu \
+                       gcc-arm-linux-gnueabi gcc-arm-linux-gnueabihf \
+                       gcc-mingw-w64-i686-posix gcc-mingw-w64-x86-64-win32
+
+       - make sure jsign is installed so we can sign Windows installers:
+       
+       https://github.com/ebourg/jsign/releases/download/5.0/jsign_5.0_all.deb
 
        - make sure ~/web/altusmetrum has no pending pullable commits
 
@@ -48,14 +59,6 @@ These are Bdale's notes on how to do a release.
 
        - update the version in configure.ac if Keith hasn't already
 
-       - 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
-
        - if this is an x.y release, then:
                git checkout -b branch-<version>
 
@@ -64,16 +67,16 @@ These are Bdale's notes on how to do a release.
                - 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 sure that doc/*.txt have the right copyright year and the
+         new release is included
+       - confirm doc/header.inc has correct copyright year
        - make absolutely sure checked-out tree is "clean" 
-       - make absolutely sure the pdclib/ submodule is on the master branch,
-         up to date, and "clean"
+       - make absolutely sure any commits Keith might have pushed to branches
+         like debian are already pulled
 
         git log > ChangeLog
-       git commit -a
-       git tag -a <version>                    # full x.y.z version
+       git commit -a -m'update ChangeLog for <version> release'
+       git tag -a <version> -m'Releasing <version>'    # full x.y.z version
 
        - make sure .git/gbp.conf set to use branch-<version> as upstream
 
@@ -82,19 +85,20 @@ These are Bdale's notes on how to do a release.
 
        - verify debian/changelog is "clean" ending in last release version
        - craft a suitable debian/changelog entry, possibly using:
+       export EMAIL=bdale@gag.com
        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 \
+               gbp buildpackage --git-no-pristine-tar \
                        --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
+               gbp buildpackage
 
        git tag debian/<version>
 
@@ -109,39 +113,33 @@ These are Bdale's notes on how to do a release.
 
        - store a stable copy of ARM binaries for production use
 
-       cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin} \
-          src/easymega-v1.0/{*.elf,*.ihx} \
-          src/easymini-v1.0/{*.elf,*.ihx} \
-          src/easymini-v2.0/{*.elf,*.ihx} \
-          src/telebt-v3.0/{*.elf,*.ihx} \
-          src/telebt-v4.0/{*.elf,*.ihx} \
-          src/teledongle-v3.0/{*.elf,*.ihx} \
-          src/telegps-v1.0/{*.elf,*.ihx} \
-          src/telegps-v2.0/{*.elf,*.ihx} \
-          src/telemega-v1.0/{*.elf,*.ihx} \
-          src/telemega-v2.0/{*.elf,*.ihx} \
-          src/telemega-v3.0/{*.elf,*.ihx} \
-          src/telemetrum-v2.0/{*.elf,*.ihx} \
-          src/telemini-v3.0/{*.elf,*.ihx} \
-          src/telelco-v2.0/{*.elf,*.ihx} \
-          src/telefireeight-v1.0/{*.elf,*.ihx} \
+       cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin,*.map} \
+          src/easymega-v[1-2].0/{*.elf,*.ihx,*.map} \
+          src/easymini-v[1-3].0/{*.elf,*.ihx,*.map} \
+          src/easymotor-v3/{*.elf,*.ihx,*.map} \
+          src/easytimer-v1/{*.elf,*.ihx,*.map} \
+          src/telebt-v[3-4].0/{*.elf,*.ihx,*.map} \
+          src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
+          src/telegps-v[1-3].0/{*.elf,*.ihx,*.map} \
+          src/telemega-v[1-6].0/{*.elf,*.ihx,*.map} \
+          src/telemetrum-v[2-4].0/{*.elf,*.ihx,*.map} \
+          src/telemini-v3.0/{*.elf,*.ihx,*.map} \
+          src/telelco-v2.0/{*.elf,*.ihx,*.map} \
+          src/telefireeight-v[1-2].0/{*.elf,*.ihx,*.map} \
           ~/altusmetrumllc/Binaries/
-       cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
-          src/easymega-v1.0/flash-loader/*.elf \
-          src/easymini-v1.0/flash-loader/*.elf \
-          src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
-          src/telebt-v3.0/flash-loader/*.elf \
-          src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
+       cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
+          src/easymega-v[1-2].0/flash-loader/*.elf \
+          src/easymini-v[1-3].0/flash-loader/*.elf \
+          src/easymotor-v3/flash-loader/*.elf \
+          src/easytimer-v1/flash-loader/*.elf \
+          src/telebt-v[3-4].0/flash-loader/{*.elf,*.bin,*.map} \
           src/teledongle-v3.0/flash-loader/*.elf \
-          src/telegps-v1.0/flash-loader/*.elf \
-          src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
-          src/telemega-v1.0/flash-loader/*.elf \
-          src/telemega-v2.0/flash-loader/*.elf \
-          src/telemega-v3.0/flash-loader/*.elf \
-          src/telemetrum-v2.0/flash-loader/*.elf \
-          src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
+          src/telegps-v[1-3].0/flash-loader/{*.elf,*.bin,*.map} \
+          src/telemega-v[1-6].0/flash-loader/*.elf \
+          src/telemetrum-v[2-4].0/flash-loader/*.elf \
+          src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
           src/telelco-v2.0/flash-loader/*.elf \
-          src/telefireeight-v1.0/flash-loader/*.elf \
+          src/telefireeight-v[1-2].0/flash-loader/*.elf \
           ~/altusmetrumllc/Binaries/loaders/
        (cd ~/altusmetrumllc ; git add Binaries ; git commit -a) 
        - remove previous versions (only keep latest release)