git.gag.com Git - fw/altos/blob - Releasing

   1 Adding a product to the release
   2
   3         Make sure the firmware and loader get built by default in
   4         src/Makefile
   5
   6         Add the firmware to altosui/Makefile.am
   7
   8         Add the firmware to altosui/altos-windows.nsi.in
   9
  10         Add the firmware to telegps/Makefile.am
  11
  12         Add the firmware to telegps/telegps-windows.nsi.in
  13
  14         Add the firmware to Releasing
  15
  16 These are Keith's notes on how to do a release
  17
  18         - update the version and date in configure.ac if Bdale hasn't already
  19
  20         - make sure there is a doc/release-notes-<version>.inc
  21
  22         - make sure doc/release-notes.inc points at that
  23
  24         - make sure doc/Makefile points at that too
  25
  26         - make sure that doc/altusmetrum-docinfo.xml has the right copyright
  27           year, and add release to the revision history at the front (release
  28           notes will be pulled in by release-notes.inc)
  29
  30 These are Bdale's notes on how to do a release.
  31
  32         - make sure build environment is up to date
  33                 sudo cowbuilder --update
  34
  35         - ensure i386 build support is available, and we have tools to build
  36           installers for Windows and Mac OS X
  37
  38                 sudo dpkg --add-architecture i386
  39                 sudo apt update
  40                 sudo apt install gcc-multilib genisoimage nsis
  41                 (need some mingw packages too, but not sure which offhand)
  42
  43         - make sure ~/web/altusmetrum has no pending pullable commits
  44
  45         git checkout master
  46
  47         - update the version in configure.ac if Keith hasn't already
  48
  49         - make sure the Google Maps API key is in the build chroot and root
  50             (cd ~/altusmetrumllc; git pull)
  51             sudo mkdir -p /var/cache/pbuilder/base.cow/opt/google /opt/google
  52             sudo cp ~/altusmetrumllc/google-maps-api-key \
  53                 /var/cache/pbuilder/base.cow/opt/google/maps-api-key
  54             sudo ln -sf /home/bdale/altusmetrumllc/google-maps-api-key \
  55                 /opt/google/maps-api-key
  56
  57         - if this is an x.y release, then:
  58                 git checkout -b branch-<version>
  59
  60         - if this is an x.y.z release, then:
  61                 git checkout branch-<version>           # the x.y parts only
  62                 - cherry-pick or merge appropriate content from master
  63
  64         - make sure there is a doc/release-notes-<version>.inc
  65         - make sure that doc/altusmetrum-docinfo.xml has the right copyright
  66           year, and add release to the revision history at the front (release
  67           notes will be pulled in automatically)
  68         - make absolutely sure checked-out tree is "clean"
  69         - make absolutely sure the pdclib/ submodule is on the master branch,
  70           up to date, and "clean"
  71
  72         git log > ChangeLog
  73         git commit -a
  74         git tag -a <version>                    # full x.y.z version
  75
  76         - make sure .git/gbp.conf set to use branch-<version> as upstream
  77
  78         git checkout debian
  79         git merge branch-<version>
  80
  81         - verify debian/changelog is "clean" ending in last release version
  82         - craft a suitable debian/changelog entry, possibly using:
  83         gbp dch --release --multimaint-merge --new-version=<version>-1
  84
  85         git commit -n debian/changelog -m "update changelog for Debian build"
  86
  87         - if this is a -1 release, then
  88                 gbp buildpackage --git-no-pristine-tar --git-submodules \
  89                         --git-upstream-branch=branch-<version> \ # eg 1.3
  90                         --git-upstream-tag=<version>             # eg 1.3.1
  91                 pristine-tar commit \
  92                         ../build-area/altos_<version>.orig.tar.gz \
  93                         branch-<version>
  94           else if this is not a -1 release
  95                 gbp buildpackage --git-submodules
  96
  97         git tag debian/<version>
  98
  99         - at this point we have packages in ~/debian/build-area/altos, now
 100           we move on to the non-Debian part of the release process
 101
 102         make distclean  (just to be sure, this should do nothing)
 103
 104         ./autogen.sh --enable-multi-arch \
 105                 --with-fat-dir=/home/bdale/web/altusmetrum/
 106         make && make fat
 107
 108         - store a stable copy of ARM binaries for production use
 109
 110         cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin} \
 111            src/easymega-v1.0/{*.elf,*.ihx} \
 112            src/easymini-v1.0/{*.elf,*.ihx} \
 113            src/easymini-v2.0/{*.elf,*.ihx} \
 114            src/telebt-v3.0/{*.elf,*.ihx} \
 115            src/telebt-v4.0/{*.elf,*.ihx} \
 116            src/teledongle-v3.0/{*.elf,*.ihx} \
 117            src/telegps-v1.0/{*.elf,*.ihx} \
 118            src/telegps-v2.0/{*.elf,*.ihx} \
 119            src/telemega-v1.0/{*.elf,*.ihx} \
 120            src/telemega-v2.0/{*.elf,*.ihx} \
 121            src/telemega-v3.0/{*.elf,*.ihx} \
 122            src/telemetrum-v2.0/{*.elf,*.ihx} \
 123            src/telemini-v3.0/{*.elf,*.ihx} \
 124            src/telelco-v2.0/{*.elf,*.ihx} \
 125            src/telefireeight-v1.0/{*.elf,*.ihx} \
 126            ~/altusmetrumllc/Binaries/
 127         cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
 128            src/easymega-v1.0/flash-loader/*.elf \
 129            src/easymini-v1.0/flash-loader/*.elf \
 130            src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
 131            src/telebt-v3.0/flash-loader/*.elf \
 132            src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
 133            src/teledongle-v3.0/flash-loader/*.elf \
 134            src/telegps-v1.0/flash-loader/*.elf \
 135            src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
 136            src/telemega-v1.0/flash-loader/*.elf \
 137            src/telemega-v2.0/flash-loader/*.elf \
 138            src/telemega-v3.0/flash-loader/*.elf \
 139            src/telemetrum-v2.0/flash-loader/*.elf \
 140            src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
 141            src/telelco-v2.0/flash-loader/*.elf \
 142            src/telefireeight-v1.0/flash-loader/*.elf \
 143            ~/altusmetrumllc/Binaries/loaders/
 144         (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
 145         - remove previous versions (only keep latest release)
 146         (cd ~/altusmetrumllc ; git push)
 147
 148         - Push new release to web site
 149
 150         make fat-install
 151         (cd doc ; make publish)
 152
 153         (cd ~/web/altusmetrum/ && \
 154                 git add */releases && git commit -m'Release <rev>' && \
 155                 git push origin master)
 156
 157         - upload the Debian package
 158
 159         - clean up
 160
 161         sudo debian/rules clean
 162         git push origin master branch-<version> debian pristine-tar
 163         git push --tags
 164
 165 Testing before a release
 166
 167         To verify that a build works, the following need to be checked
 168         on each platform:
 169
 170         1) Install package
 171
 172         2) Connect TM *and* TD devices. Verify that you can Monitor
 173            Flight from the TD and Configure Telemetrum from the TM.
 174
 175         3) Replay Flight, using your favorite .eeprom file. Check
 176            each tab, especially the 'Site Map' tab. Make sure the
 177            sound works.
 178
 179         4) Graph Data. Graph a favorite .eeprom file. Make sure you
 180            can zoom in on some region of the graph.