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
  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
  51         - make sure jsign is installed so we can sign Windows installers
  52
  53         - make sure ~/web/altusmetrum has no pending pullable commits
  54
  55         git checkout master
  56
  57         - update the version in configure.ac if Keith hasn't already
  58
  59         - if this is an x.y release, then:
  60                 git checkout -b branch-<version>
  61
  62         - if this is an x.y.z release, then:
  63                 git checkout branch-<version>           # the x.y parts only
  64                 - cherry-pick or merge appropriate content from master
  65
  66         - make sure there is a doc/release-notes-<version>.inc
  67         - make sure that doc/*.txt have the right copyright year and the
  68           new release is included
  69         - confirm doc/header.inc has correct copyright year
  70         - make absolutely sure checked-out tree is "clean"
  71         - make absolutely sure any commits Keith might have pushed to branches
  72           like debian are already pulled
  73
  74         git log > ChangeLog
  75         git commit -a
  76         git tag -a <version>                    # full x.y.z version
  77
  78         - make sure .git/gbp.conf set to use branch-<version> as upstream
  79
  80         git checkout debian
  81         git merge branch-<version>
  82
  83         - verify debian/changelog is "clean" ending in last release version
  84         - craft a suitable debian/changelog entry, possibly using:
  85         export EMAIL=bdale@gag.com
  86         gbp dch --release --multimaint-merge --new-version=<version>-1
  87
  88         git commit -n debian/changelog -m "update changelog for Debian build"
  89
  90         - if this is a -1 release, then
  91                 gbp buildpackage --git-no-pristine-tar \
  92                         --git-upstream-branch=branch-<version> \ # eg 1.3
  93                         --git-upstream-tag=<version>             # eg 1.3.1
  94                 pristine-tar commit \
  95                         ../build-area/altos_<version>.orig.tar.gz \
  96                         branch-<version>
  97           else if this is not a -1 release
  98                 gbp buildpackage
  99
 100         git tag debian/<version>
 101
 102         - at this point we have packages in ~/debian/build-area/altos, now
 103           we move on to the non-Debian part of the release process
 104
 105         make distclean  (just to be sure, this should do nothing)
 106
 107         ./autogen.sh --enable-multi-arch \
 108                 --with-fat-dir=/home/bdale/web/altusmetrum/
 109         make && make fat
 110
 111         - store a stable copy of ARM binaries for production use
 112
 113         cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin,*.map} \
 114            src/easymega-v[1-2].0/{*.elf,*.ihx,*.map} \
 115            src/easymini-v[1-3].0/{*.elf,*.ihx,*.map} \
 116            src/easymotor-v3/{*.elf,*.ihx,*.map} \
 117            src/easytimer-v1/{*.elf,*.ihx,*.map} \
 118            src/telebt-v[3-4].0/{*.elf,*.ihx,*.map} \
 119            src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
 120            src/telegps-v[1-2].0/{*.elf,*.ihx,*.map} \
 121            src/telemega-v[1-6].0/{*.elf,*.ihx,*.map} \
 122            src/telemetrum-v[2-4].0/{*.elf,*.ihx,*.map} \
 123            src/telemini-v3.0/{*.elf,*.ihx,*.map} \
 124            src/telelco-v2.0/{*.elf,*.ihx,*.map} \
 125            src/telefireeight-v[1-2].0/{*.elf,*.ihx,*.map} \
 126            ~/altusmetrumllc/Binaries/
 127         cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
 128            src/easymega-v[1-2].0/flash-loader/*.elf \
 129            src/easymini-v[1-3].0/flash-loader/*.elf \
 130            src/easymotor-v3/flash-loader/*.elf \
 131            src/easytimer-v1/flash-loader/*.elf \
 132            src/telebt-v[3-4].0/flash-loader/{*.elf,*.bin,*.map} \
 133            src/teledongle-v3.0/flash-loader/*.elf \
 134            src/telegps-v[1-2].0/flash-loader/{*.elf,*.bin,*.map} \
 135            src/telemega-v[1-6].0/flash-loader/*.elf \
 136            src/telemetrum-v[2-4].0/flash-loader/*.elf \
 137            src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
 138            src/telelco-v2.0/flash-loader/*.elf \
 139            src/telefireeight-v[1-2].0/flash-loader/*.elf \
 140            ~/altusmetrumllc/Binaries/loaders/
 141         (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
 142         - remove previous versions (only keep latest release)
 143         (cd ~/altusmetrumllc ; git push)
 144
 145         - Push new release to web site
 146
 147         make fat-install
 148         (cd doc ; make publish)
 149
 150         (cd ~/web/altusmetrum/ && \
 151                 git add */releases && git commit -m'Release <rev>' && \
 152                 git push origin master)
 153
 154         - upload the Debian package
 155
 156         - clean up
 157
 158         sudo debian/rules clean
 159         git push origin master branch-<version> debian pristine-tar
 160         git push --tags
 161
 162 Testing before a release
 163
 164         To verify that a build works, the following need to be checked
 165         on each platform:
 166
 167         1) Install package
 168
 169         2) Connect TM *and* TD devices. Verify that you can Monitor
 170            Flight from the TD and Configure Telemetrum from the TM.
 171
 172         3) Replay Flight, using your favorite .eeprom file. Check
 173            each tab, especially the 'Site Map' tab. Make sure the
 174            sound works.
 175
 176         4) Graph Data. Graph a favorite .eeprom file. Make sure you
 177            can zoom in on some region of the graph.