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