1 Adding a product to the release
3 Make sure the firmware and loader get built by default in
6 Add firmware targets to fat_altos target in Makefile.am
8 Add the firmware to altosui/Makefile.am
10 Add the firmware to altosui/altos-windows.nsi.in
12 Add the firmware to telegps/Makefile.am
14 Add the firmware to telegps/telegps-windows.nsi.in
16 Add the firmware to Releasing
18 These are Keith's notes on how to do a release
20 - update the version and date in configure.ac if Bdale hasn't already
22 - follow instructions in doc/RELNOTES
24 - make sure there is a doc/release-notes-<version>.inc
26 - make sure doc/release-notes.inc points at that
28 - make sure doc/Makefile points at that too
30 These are Bdale's notes on how to do a release.
32 - make sure Debian build environment is up to date
33 sudo cowbuilder --update
35 - make sure fat build environment is up to date
36 sudo apt update && sudo apt upgrade
38 - ensure i386 build support is available, and we have tools to build
39 installers for Windows and Mac OS X
41 sudo dpkg --add-architecture i386
43 sudo apt install gcc-multilib genisoimage nsis
44 (need some mingw packages too, but not sure which offhand)
46 - make sure ~/web/altusmetrum has no pending pullable commits
50 - update the version in configure.ac if Keith hasn't already
52 - if this is an x.y release, then:
53 git checkout -b branch-<version>
55 - if this is an x.y.z release, then:
56 git checkout branch-<version> # the x.y parts only
57 - cherry-pick or merge appropriate content from master
59 - make sure there is a doc/release-notes-<version>.inc
60 - make sure that doc/*.txt have the right copyright year and the
61 new release is included
62 - make absolutely sure checked-out tree is "clean"
63 - make absolutely sure any commits Keith might have pushed to branches
64 like debian are already pulled
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 \
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
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/easymega-v2.0/{*.elf,*.ihx} \
107 src/easymini-v1.0/{*.elf,*.ihx} \
108 src/easymini-v2.0/{*.elf,*.ihx} \
109 src/telebt-v3.0/{*.elf,*.ihx} \
110 src/telebt-v4.0/{*.elf,*.ihx} \
111 src/teledongle-v3.0/{*.elf,*.ihx} \
112 src/telegps-v1.0/{*.elf,*.ihx} \
113 src/telegps-v2.0/{*.elf,*.ihx} \
114 src/telemega-v[1-4].0/{*.elf,*.ihx} \
115 src/telemetrum-v2.0/{*.elf,*.ihx} \
116 src/telemetrum-v3.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 src/telefireeight-v2.0/{*.elf,*.ihx} \
121 ~/altusmetrumllc/Binaries/
122 cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
123 src/easymega-v1.0/flash-loader/*.elf \
124 src/easymega-v2.0/flash-loader/*.elf \
125 src/easymini-v1.0/flash-loader/*.elf \
126 src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
127 src/telebt-v3.0/flash-loader/*.elf \
128 src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
129 src/teledongle-v3.0/flash-loader/*.elf \
130 src/telegps-v1.0/flash-loader/*.elf \
131 src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
132 src/telemega-v[1-4].0/flash-loader/*.elf \
133 src/telemetrum-v2.0/flash-loader/*.elf \
134 src/telemetrum-v3.0/flash-loader/*.elf \
135 src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
136 src/telelco-v2.0/flash-loader/*.elf \
137 src/telefireeight-v1.0/flash-loader/*.elf \
138 src/telefireeight-v2.0/flash-loader/*.elf \
139 ~/altusmetrumllc/Binaries/loaders/
140 (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
141 - remove previous versions (only keep latest release)
142 (cd ~/altusmetrumllc ; git push)
144 - Push new release to web site
147 (cd doc ; make publish)
149 (cd ~/web/altusmetrum/ && \
150 git add */releases && git commit -m'Release <rev>' && \
151 git push origin master)
153 - upload the Debian package
157 sudo debian/rules clean
158 git push origin master branch-<version> debian pristine-tar
161 Testing before a release
163 To verify that a build works, the following need to be checked
168 2) Connect TM *and* TD devices. Verify that you can Monitor
169 Flight from the TD and Configure Telemetrum from the TM.
171 3) Replay Flight, using your favorite .eeprom file. Check
172 each tab, especially the 'Site Map' tab. Make sure the
175 4) Graph Data. Graph a favorite .eeprom file. Make sure you
176 can zoom in on some region of the graph.