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 firmware targets to fat_altos target in Makefile.am
   7
   8         Add the firmware to altosui/Makefile.am
   9
  10         Add the firmware to altosui/altos-windows.nsi.in
  11
  12         Add the firmware to telegps/Makefile.am
  13
  14         Add the firmware to telegps/telegps-windows.nsi.in
  15
  16         Add the firmware to Releasing
  17
  18 These are Keith's notes on how to do a release
  19
  20         - update the version and date in configure.ac if Bdale hasn't already
  21
  22         - update the ANDROID_VERSION in configure.ac if releasing AltosDroid
  23
  24         - follow instructions in doc/RELNOTES
  25
  26         - make sure there is a doc/release-notes-<version>.inc
  27
  28         - make sure doc/release-notes.inc points at that
  29
  30         - make sure doc/Makefile points at that too
  31
  32         - confirm doc/header.inc has correct copyright year
  33
  34
  35 These are Bdale's notes on how to do a release.
  36
  37         - make sure Debian build environment is up to date
  38                 sudo cowbuilder --update
  39
  40         - make sure fat build environment is up to date
  41                 sudo apt update && sudo apt upgrade && sudo apt autoremove
  42
  43         - ensure i386 build support is available, and we have tools to build
  44           installers for Windows and Mac OS X
  45
  46                 sudo apt update
  47                 sudo apt install genisoimage nsis \
  48                         gcc-i686-linux-gnu gcc-aarch64-linux-gnu \
  49                         gcc-arm-linux-gnueabi gcc-arm-linux-gnueabihf \
  50                         gcc-mingw-w64-i686-posix gcc-mingw-w64-x86-64-win32
  51
  52         - make sure jsign is installed so we can sign Windows installers:
  53
  54         https://github.com/ebourg/jsign/releases/download/5.0/jsign_5.0_all.deb
  55
  56         - make sure ~/web/altusmetrum has no pending pullable commits
  57
  58         git checkout master
  59
  60         - update the version in configure.ac if Keith hasn't already
  61
  62         - if this is an x.y release, then:
  63                 git checkout -b branch-<version>
  64
  65         - if this is an x.y.z release, then:
  66                 git checkout branch-<version>           # the x.y parts only
  67                 - cherry-pick or merge appropriate content from master
  68
  69         - make sure there is a doc/release-notes-<version>.inc
  70         - make sure that doc/*.txt have the right copyright year and the
  71           new release is included
  72         - confirm doc/header.inc has correct copyright year
  73         - make absolutely sure checked-out tree is "clean"
  74         - make absolutely sure any commits Keith might have pushed to branches
  75           like debian are already pulled
  76
  77         git log > ChangeLog
  78         git commit -a -m'update ChangeLog for <version> release'
  79         git tag -a <version> -m'Releasing <version>'    # full x.y.z version
  80
  81         - make sure .git/gbp.conf set to use branch-<version> as upstream
  82
  83         git checkout debian
  84         git merge branch-<version>
  85
  86         - verify debian/changelog is "clean" ending in last release version
  87         - craft a suitable debian/changelog entry, possibly using:
  88         export EMAIL=bdale@gag.com
  89         gbp dch --release --multimaint-merge --new-version=<version>-1
  90
  91         git commit -n debian/changelog -m "update changelog for Debian build"
  92
  93         - if this is a -1 release, then
  94                 gbp buildpackage --git-no-pristine-tar \
  95                         --git-upstream-branch=branch-<version> \ # eg 1.3
  96                         --git-upstream-tag=<version>             # eg 1.3.1
  97                 pristine-tar commit \
  98                         ../build-area/altos_<version>.orig.tar.gz \
  99                         branch-<version>
 100           else if this is not a -1 release
 101                 gbp buildpackage
 102
 103         git tag debian/<version>
 104
 105         - at this point we have packages in ~/debian/build-area/altos, now
 106           we move on to the non-Debian part of the release process
 107
 108         make distclean  (just to be sure, this should do nothing)
 109
 110         ./autogen.sh --enable-multi-arch \
 111                 --with-fat-dir=/home/bdale/web/altusmetrum/
 112         make && make fat
 113
 114         - store a stable copy of ARM binaries for production use
 115
 116         cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin,*.map} \
 117            src/easymega-v[1-2].0/{*.elf,*.ihx,*.map} \
 118            src/easymini-v[1-3].0/{*.elf,*.ihx,*.map} \
 119            src/easymotor-v3/{*.elf,*.ihx,*.map} \
 120            src/easytimer-v1/{*.elf,*.ihx,*.map} \
 121            src/telebt-v[3-4].0/{*.elf,*.ihx,*.map} \
 122            src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
 123            src/telegps-v[1-3].0/{*.elf,*.ihx,*.map} \
 124            src/telemega-v[1-6].0/{*.elf,*.ihx,*.map} \
 125            src/telemetrum-v[2-4].0/{*.elf,*.ihx,*.map} \
 126            src/telemini-v3.0/{*.elf,*.ihx,*.map} \
 127            src/telelco-v2.0/{*.elf,*.ihx,*.map} \
 128            src/telefireeight-v[1-2].0/{*.elf,*.ihx,*.map} \
 129            ~/altusmetrumllc/Binaries/
 130         cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
 131            src/easymega-v[1-2].0/flash-loader/*.elf \
 132            src/easymini-v[1-3].0/flash-loader/*.elf \
 133            src/easymotor-v3/flash-loader/*.elf \
 134            src/easytimer-v1/flash-loader/*.elf \
 135            src/telebt-v[3-4].0/flash-loader/{*.elf,*.bin,*.map} \
 136            src/teledongle-v3.0/flash-loader/*.elf \
 137            src/telegps-v[1-3].0/flash-loader/{*.elf,*.bin,*.map} \
 138            src/telemega-v[1-6].0/flash-loader/*.elf \
 139            src/telemetrum-v[2-4].0/flash-loader/*.elf \
 140            src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
 141            src/telelco-v2.0/flash-loader/*.elf \
 142            src/telefireeight-v[1-2].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.