1 Adding a product to the release
3 Make sure the firmware and loader get built by default in
6 Add the firmware to altosui/Makefile.am
8 Add the firmware to altosui/altos-windows.nsi.in
10 Add the firmware to telegps/Makefile.am
12 Add the firmware to telegps/telegps-windows.nsi.in
14 Add the firmware to Releasing
16 These are Keith's notes on how to do a release
18 - update the version and date in configure.ac if Bdale hasn't already
20 - follow instructions in doc/RELNOTES
22 - make sure there is a doc/release-notes-<version>.inc
24 - make sure doc/release-notes.inc points at that
26 - make sure doc/Makefile points at that too
28 - make sure that doc/altusmetrum-docinfo.xml has the right copyright
29 year, and add release to the revision history at the front (release
30 notes will be pulled in by release-notes.inc)
32 These are Bdale's notes on how to do a release.
34 - make sure build environment is up to date
35 sudo cowbuilder --update
37 - ensure i386 build support is available, and we have tools to build
38 installers for Windows and Mac OS X
40 sudo dpkg --add-architecture i386
42 sudo apt install gcc-multilib genisoimage nsis
43 (need some mingw packages too, but not sure which offhand)
45 - make sure ~/web/altusmetrum has no pending pullable commits
49 - update the version in configure.ac if Keith hasn't already
51 - make sure the Google Maps API key is in the build chroot and root
52 (cd ~/altusmetrumllc; git pull)
53 sudo mkdir -p /var/cache/pbuilder/base.cow/opt/google /opt/google
54 sudo cp ~/altusmetrumllc/google-maps-api-key \
55 /var/cache/pbuilder/base.cow/opt/google/maps-api-key
56 sudo ln -sf /home/bdale/altusmetrumllc/google-maps-api-key \
57 /opt/google/maps-api-key
59 - if this is an x.y release, then:
60 git checkout -b branch-<version>
62 - if this is an x.y.z release, then:
63 git checkout branch-<version> # the x.y parts only
64 - cherry-pick or merge appropriate content from master
66 - make sure there is a doc/release-notes-<version>.inc
67 - make sure that doc/altusmetrum-docinfo.xml has the right copyright
68 year, and add release to the revision history at the front (release
69 notes will be pulled in automatically)
70 - make absolutely sure checked-out tree is "clean"
71 - make absolutely sure the pdclib/ submodule is on the master branch,
72 up to date, and "clean"
76 git tag -a <version> # full x.y.z version
78 - make sure .git/gbp.conf set to use branch-<version> as upstream
81 git merge branch-<version>
83 - verify debian/changelog is "clean" ending in last release version
84 - craft a suitable debian/changelog entry, possibly using:
85 gbp dch --release --multimaint-merge --new-version=<version>-1
87 git commit -n debian/changelog -m "update changelog for Debian build"
89 - if this is a -1 release, then
90 gbp buildpackage --git-no-pristine-tar --git-submodules \
91 --git-upstream-branch=branch-<version> \ # eg 1.3
92 --git-upstream-tag=<version> # eg 1.3.1
94 ../build-area/altos_<version>.orig.tar.gz \
96 else if this is not a -1 release
97 gbp buildpackage --git-submodules
99 git tag debian/<version>
101 - at this point we have packages in ~/debian/build-area/altos, now
102 we move on to the non-Debian part of the release process
104 make distclean (just to be sure, this should do nothing)
106 ./autogen.sh --enable-multi-arch \
107 --with-fat-dir=/home/bdale/web/altusmetrum/
110 - store a stable copy of ARM binaries for production use
112 cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin} \
113 src/easymega-v1.0/{*.elf,*.ihx} \
114 src/easymini-v1.0/{*.elf,*.ihx} \
115 src/easymini-v2.0/{*.elf,*.ihx} \
116 src/telebt-v3.0/{*.elf,*.ihx} \
117 src/telebt-v4.0/{*.elf,*.ihx} \
118 src/teledongle-v3.0/{*.elf,*.ihx} \
119 src/telegps-v1.0/{*.elf,*.ihx} \
120 src/telegps-v2.0/{*.elf,*.ihx} \
121 src/telemega-v1.0/{*.elf,*.ihx} \
122 src/telemega-v2.0/{*.elf,*.ihx} \
123 src/telemega-v3.0/{*.elf,*.ihx} \
124 src/telemetrum-v2.0/{*.elf,*.ihx} \
125 src/telemini-v3.0/{*.elf,*.ihx} \
126 src/telelco-v2.0/{*.elf,*.ihx} \
127 src/telefireeight-v1.0/{*.elf,*.ihx} \
128 ~/altusmetrumllc/Binaries/
129 cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
130 src/easymega-v1.0/flash-loader/*.elf \
131 src/easymini-v1.0/flash-loader/*.elf \
132 src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
133 src/telebt-v3.0/flash-loader/*.elf \
134 src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
135 src/teledongle-v3.0/flash-loader/*.elf \
136 src/telegps-v1.0/flash-loader/*.elf \
137 src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
138 src/telemega-v1.0/flash-loader/*.elf \
139 src/telemega-v2.0/flash-loader/*.elf \
140 src/telemega-v3.0/flash-loader/*.elf \
141 src/telemetrum-v2.0/flash-loader/*.elf \
142 src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
143 src/telelco-v2.0/flash-loader/*.elf \
144 src/telefireeight-v1.0/flash-loader/*.elf \
145 ~/altusmetrumllc/Binaries/loaders/
146 (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
147 - remove previous versions (only keep latest release)
148 (cd ~/altusmetrumllc ; git push)
150 - Push new release to web site
153 (cd doc ; make publish)
155 (cd ~/web/altusmetrum/ && \
156 git add */releases && git commit -m'Release <rev>' && \
157 git push origin master)
159 - upload the Debian package
163 sudo debian/rules clean
164 git push origin master branch-<version> debian pristine-tar
167 Testing before a release
169 To verify that a build works, the following need to be checked
174 2) Connect TM *and* TD devices. Verify that you can Monitor
175 Flight from the TD and Configure Telemetrum from the TM.
177 3) Replay Flight, using your favorite .eeprom file. Check
178 each tab, especially the 'Site Map' tab. Make sure the
181 4) Graph Data. Graph a favorite .eeprom file. Make sure you
182 can zoom in on some region of the graph.