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 ~/web/altusmetrum has no pending pullable commits
  52
  53         git checkout master
  54
  55         - update the version in configure.ac if Keith hasn't already
  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/*.txt have the right copyright year and the
  66           new release is included
  67         - confirm doc/header.inc has correct copyright year
  68         - make absolutely sure checked-out tree is "clean"
  69         - make absolutely sure any commits Keith might have pushed to branches
  70           like debian are already pulled
  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 \
  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
  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,*.map} \
 111            src/easymega-v[1-2].0/{*.elf,*.ihx,*.map} \
 112            src/easymini-v[1-2].0/{*.elf,*.ihx,*.map} \
 113            src/easymotor-v2/{*.elf,*.ihx,*.map} \
 114            src/easytimer-v1/{*.elf,*.ihx,*.map} \
 115            src/telebt-v[3-4].0/{*.elf,*.ihx,*.map} \
 116            src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
 117            src/telegps-v[1-2].0/{*.elf,*.ihx,*.map} \
 118            src/telemega-v[1-5].0/{*.elf,*.ihx,*.map} \
 119            src/telemetrum-v[2-3].0/{*.elf,*.ihx,*.map} \
 120            src/telemini-v3.0/{*.elf,*.ihx,*.map} \
 121            src/telelco-v2.0/{*.elf,*.ihx,*.map} \
 122            src/telefireeight-v[1-2].0/{*.elf,*.ihx,*.map} \
 123            ~/altusmetrumllc/Binaries/
 124         cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
 125            src/easymega-v[1-2].0/flash-loader/*.elf \
 126            src/easymini-v[1-2].0/flash-loader/*.elf \
 127            src/easymotor-v2/flash-loader/*.elf \
 128            src/easytimer-v1/flash-loader/*.elf \
 129            src/telebt-v[3-4].0/flash-loader/{*.elf,*.bin,*.map} \
 130            src/teledongle-v3.0/flash-loader/*.elf \
 131            src/telegps-v[1-2].0/flash-loader/*.elf \
 132            src/telemega-v[1-5].0/flash-loader/*.elf \
 133            src/telemetrum-v[2-3].0/flash-loader/*.elf \
 134            src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
 135            src/telelco-v2.0/flash-loader/*.elf \
 136            src/telefireeight-v[1-2].0/flash-loader/*.elf \
 137            ~/altusmetrumllc/Binaries/loaders/
 138         (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
 139         - remove previous versions (only keep latest release)
 140         (cd ~/altusmetrumllc ; git push)
 141
 142         - Push new release to web site
 143
 144         make fat-install
 145         (cd doc ; make publish)
 146
 147         (cd ~/web/altusmetrum/ && \
 148                 git add */releases && git commit -m'Release <rev>' && \
 149                 git push origin master)
 150
 151         - upload the Debian package
 152
 153         - clean up
 154
 155         sudo debian/rules clean
 156         git push origin master branch-<version> debian pristine-tar
 157         git push --tags
 158
 159 Testing before a release
 160
 161         To verify that a build works, the following need to be checked
 162         on each platform:
 163
 164         1) Install package
 165
 166         2) Connect TM *and* TD devices. Verify that you can Monitor
 167            Flight from the TD and Configure Telemetrum from the TM.
 168
 169         3) Replay Flight, using your favorite .eeprom file. Check
 170            each tab, especially the 'Site Map' tab. Make sure the
 171            sound works.
 172
 173         4) Graph Data. Graph a favorite .eeprom file. Make sure you
 174            can zoom in on some region of the graph.