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 - if this is an x.y release, then:
52 git checkout -b branch-<version>
54 - if this is an x.y.z release, then:
55 git checkout branch-<version> # the x.y parts only
56 - cherry-pick or merge appropriate content from master
58 - make sure there is a doc/release-notes-<version>.inc
59 - make sure that doc/altusmetrum-docinfo.xml has the right copyright
60 year, and add release to the revision history at the front (release
61 notes will be pulled in automatically)
62 - make absolutely sure checked-out tree is "clean"
63 - make absolutely sure the pdclib/ submodule is on the master branch,
64 up to date, and "clean"
68 git tag -a <version> # full x.y.z version
70 - make sure .git/gbp.conf set to use branch-<version> as upstream
73 git merge branch-<version>
75 - verify debian/changelog is "clean" ending in last release version
76 - craft a suitable debian/changelog entry, possibly using:
77 gbp dch --release --multimaint-merge --new-version=<version>-1
79 git commit -n debian/changelog -m "update changelog for Debian build"
81 - if this is a -1 release, then
82 gbp buildpackage --git-no-pristine-tar --git-submodules \
83 --git-upstream-branch=branch-<version> \ # eg 1.3
84 --git-upstream-tag=<version> # eg 1.3.1
86 ../build-area/altos_<version>.orig.tar.gz \
88 else if this is not a -1 release
89 gbp buildpackage --git-submodules
91 git tag debian/<version>
93 - at this point we have packages in ~/debian/build-area/altos, now
94 we move on to the non-Debian part of the release process
96 make distclean (just to be sure, this should do nothing)
98 ./autogen.sh --enable-multi-arch \
99 --with-fat-dir=/home/bdale/web/altusmetrum/
102 - store a stable copy of ARM binaries for production use
104 cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin} \
105 src/easymega-v1.0/{*.elf,*.ihx} \
106 src/easymini-v1.0/{*.elf,*.ihx} \
107 src/easymini-v2.0/{*.elf,*.ihx} \
108 src/telebt-v3.0/{*.elf,*.ihx} \
109 src/telebt-v4.0/{*.elf,*.ihx} \
110 src/teledongle-v3.0/{*.elf,*.ihx} \
111 src/telegps-v1.0/{*.elf,*.ihx} \
112 src/telegps-v2.0/{*.elf,*.ihx} \
113 src/telemega-v1.0/{*.elf,*.ihx} \
114 src/telemega-v2.0/{*.elf,*.ihx} \
115 src/telemega-v3.0/{*.elf,*.ihx} \
116 src/telemetrum-v2.0/{*.elf,*.ihx} \
117 src/telemini-v3.0/{*.elf,*.ihx} \
118 src/telelco-v2.0/{*.elf,*.ihx} \
119 src/telefireeight-v1.0/{*.elf,*.ihx} \
120 ~/altusmetrumllc/Binaries/
121 cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
122 src/easymega-v1.0/flash-loader/*.elf \
123 src/easymini-v1.0/flash-loader/*.elf \
124 src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
125 src/telebt-v3.0/flash-loader/*.elf \
126 src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
127 src/teledongle-v3.0/flash-loader/*.elf \
128 src/telegps-v1.0/flash-loader/*.elf \
129 src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
130 src/telemega-v1.0/flash-loader/*.elf \
131 src/telemega-v2.0/flash-loader/*.elf \
132 src/telemega-v3.0/flash-loader/*.elf \
133 src/telemetrum-v2.0/flash-loader/*.elf \
134 src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
135 src/telelco-v2.0/flash-loader/*.elf \
136 src/telefireeight-v1.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)
142 - Push new release to web site
145 (cd doc ; make publish)
147 (cd ~/web/altusmetrum/ && \
148 git add */releases && git commit -m'Release <rev>' && \
149 git push origin master)
151 - upload the Debian package
155 sudo debian/rules clean
156 git push origin master branch-<version> debian pristine-tar
159 Testing before a release
161 To verify that a build works, the following need to be checked
166 2) Connect TM *and* TD devices. Verify that you can Monitor
167 Flight from the TD and Configure Telemetrum from the TM.
169 3) Replay Flight, using your favorite .eeprom file. Check
170 each tab, especially the 'Site Map' tab. Make sure the
173 4) Graph Data. Graph a favorite .eeprom file. Make sure you
174 can zoom in on some region of the graph.