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