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