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         Add new product specs to doc/specs.inc
  19
  20 These are Keith's notes on how to do a release
  21
  22         - update the version and date in configure.ac if Bdale hasn't already
  23
  24         - update the ANDROID_VERSION in configure.ac if releasing AltosDroid
  25
  26         - follow instructions in doc/RELNOTES
  27
  28         - make sure there is a doc/release-notes-<version>.inc
  29
  30         - make sure doc/release-notes.inc points at that
  31
  32         - make sure doc/Makefile points at that too
  33
  34         - confirm doc/header.inc has correct copyright year
  35
  36
  37 These are Bdale's notes on how to do a release.
  38
  39         - make sure Debian build environment is up to date
  40                 sudo cowbuilder --update
  41
  42         - make sure fat build environment is up to date
  43                 sudo apt update && sudo apt upgrade && sudo apt autoremove
  44
  45         - ensure i386 build support is available, and we have tools to build
  46           installers for Windows and Mac OS X
  47
  48                 sudo apt update
  49                 sudo apt install genisoimage nsis gcc-avr avr-libc \
  50                         gcc-i686-linux-gnu gcc-aarch64-linux-gnu \
  51                         gcc-arm-linux-gnueabi gcc-arm-linux-gnueabihf \
  52                         gcc-mingw-w64-i686-posix gcc-mingw-w64-x86-64-win32
  53
  54         - make sure jsign is installed so we can sign Windows installers:
  55
  56         https://github.com/ebourg/jsign/releases/download/5.0/jsign_5.0_all.deb
  57
  58         - make sure ~/web/altusmetrum has no pending pullable commits
  59
  60         git checkout master
  61
  62         - update the version in configure.ac if Keith hasn't already
  63
  64         - if this is an x.y release, then:
  65                 git checkout -b branch-<version>
  66
  67         - if this is an x.y.z release, then:
  68                 git checkout branch-<version>           # the x.y parts only
  69                 - cherry-pick or merge appropriate content from master
  70
  71         - make sure there is a doc/release-notes-<version>.inc
  72         - make sure that doc/*.txt have the right copyright year and the
  73           new release is included
  74         - confirm doc/header.inc has correct copyright year
  75         - make absolutely sure checked-out tree is "clean"
  76         - make absolutely sure any commits Keith might have pushed to branches
  77           like debian are already pulled
  78
  79         git log > ChangeLog
  80         git commit -a -m'update ChangeLog for <version> release'
  81         git tag -a <version> -m'Releasing <version>'    # full x.y.z version
  82
  83         - make sure .git/gbp.conf set to use branch-<version> as upstream
  84
  85         git checkout debian
  86         git merge branch-<version>
  87
  88         - verify debian/changelog is "clean" ending in last release version
  89         - craft a suitable debian/changelog entry, possibly using:
  90         export EMAIL=bdale@gag.com
  91         gbp dch --release --multimaint-merge --new-version=<version>-1
  92
  93         git commit -n debian/changelog -m "update changelog for Debian build"
  94
  95         - review debian/patches, all should be obsoleted by a new release, so
  96           take care of any that are there and commit the changes
  97
  98         - if this is a -1 release, then
  99                 gbp buildpackage --git-no-pristine-tar \
 100                         --git-upstream-branch=branch-<version> \ # eg 1.3
 101                         --git-upstream-tag=<version>             # eg 1.3.1
 102                 pristine-tar commit \
 103                         ../build-area/altos_<version>.orig.tar.gz \
 104                         branch-<version>
 105           else if this is not a -1 release
 106                 gbp buildpackage
 107
 108         git tag debian/<version>
 109
 110         - at this point we have packages in ~/debian/build-area/altos, now
 111           we move on to the non-Debian part of the release process
 112
 113         make distclean  (just to be sure, this should do nothing)
 114
 115         ./autogen.sh --enable-multi-arch \
 116                 --with-fat-dir=/home/bdale/web/altusmetrum/
 117         make && make fat
 118
 119         - store a stable copy of ARM binaries for production use
 120
 121         cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin,*.map} \
 122            src/easymega-v[1-3].0/{*.elf,*.ihx,*.map} \
 123            src/easymini-v[1-3].0/{*.elf,*.ihx,*.map} \
 124            src/easymotor-v3/{*.elf,*.ihx,*.map} \
 125            src/easytimer-v[1-2]/{*.elf,*.ihx,*.map} \
 126            src/telebt-v[3-4].0/{*.elf,*.ihx,*.map} \
 127            src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
 128            src/telegps-v[1-4].0/{*.elf,*.ihx,*.map} \
 129            src/telemega-v[1-7].0/{*.elf,*.ihx,*.map} \
 130            src/telemetrum-v[2-4].0/{*.elf,*.ihx,*.map} \
 131            src/telemini-v3.0/{*.elf,*.ihx,*.map} \
 132            src/telelco-v[2-3].0/{*.elf,*.ihx,*.map} \
 133            src/telefireeight-v[1-2].0/{*.elf,*.ihx,*.map} \
 134            ~/altusmetrumllc/Binaries/
 135         cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
 136            src/easymega-v[1-3].0/flash-loader/*.elf \
 137            src/easymini-v[1-3].0/flash-loader/*.elf \
 138            src/easymotor-v3/flash-loader/*.elf \
 139            src/easytimer-v[1-2]/flash-loader/*.elf \
 140            src/telebt-v[3-4].0/flash-loader/{*.elf,*.bin,*.map} \
 141            src/teledongle-v3.0/flash-loader/*.elf \
 142            src/telegps-v[1-4].0/flash-loader/{*.elf,*.bin,*.map} \
 143            src/telemega-v[1-7].0/flash-loader/*.elf \
 144            src/telemetrum-v[2-4].0/flash-loader/*.elf \
 145            src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
 146            src/telelco-v[2-3].0/flash-loader/*.elf \
 147            src/telefireeight-v[1-2].0/flash-loader/*.elf \
 148            ~/altusmetrumllc/Binaries/loaders/
 149         (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
 150         - remove previous versions (only keep latest release)
 151         (cd ~/altusmetrumllc ; git push)
 152
 153         - Push new release to web site
 154
 155         make fat-install
 156         (cd doc ; make publish)
 157
 158         (cd ~/web/altusmetrum/ && \
 159                 git add */releases && git commit -m'Release <rev>' && \
 160                 git push origin master)
 161
 162         - upload the Debian package
 163
 164         - clean up
 165
 166         sudo debian/rules clean
 167         git push origin master branch-<version> debian pristine-tar
 168         git push --tags
 169
 170 Testing before a release
 171
 172         To verify that a build works, the following need to be checked
 173         on each platform:
 174
 175         1) Install package
 176
 177         2) Connect TM *and* TD devices. Verify that you can Monitor
 178            Flight from the TD and Configure Telemetrum from the TM.
 179
 180         3) Replay Flight, using your favorite .eeprom file. Check
 181            each tab, especially the 'Site Map' tab. Make sure the
 182            sound works.
 183
 184         4) Graph Data. Graph a favorite .eeprom file. Make sure you
 185            can zoom in on some region of the graph.