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 - confirm doc/header.inc has correct copyright year
32 These are Bdale's notes on how to do a release.
34 - make sure Debian build environment is up to date
35 sudo cowbuilder --update
37 - make sure fat build environment is up to date
38 sudo apt update && sudo apt upgrade
40 - ensure i386 build support is available, and we have tools to build
41 installers for Windows and Mac OS X
43 sudo dpkg --add-architecture i386
45 sudo apt install gcc-multilib genisoimage nsis
46 (need some mingw packages too, but not sure which offhand)
48 - make sure ~/web/altusmetrum has no pending pullable commits
52 - update the version in configure.ac if Keith hasn't already
54 - if this is an x.y release, then:
55 git checkout -b branch-<version>
57 - if this is an x.y.z release, then:
58 git checkout branch-<version> # the x.y parts only
59 - cherry-pick or merge appropriate content from master
61 - make sure there is a doc/release-notes-<version>.inc
62 - make sure that doc/*.txt have the right copyright year and the
63 new release is included
64 - confirm doc/header.inc has correct copyright year
65 - make absolutely sure checked-out tree is "clean"
66 - make absolutely sure any commits Keith might have pushed to branches
67 like debian are already pulled
71 git tag -a <version> # full x.y.z version
73 - make sure .git/gbp.conf set to use branch-<version> as upstream
76 git merge branch-<version>
78 - verify debian/changelog is "clean" ending in last release version
79 - craft a suitable debian/changelog entry, possibly using:
80 gbp dch --release --multimaint-merge --new-version=<version>-1
82 git commit -n debian/changelog -m "update changelog for Debian build"
84 - if this is a -1 release, then
85 gbp buildpackage --git-no-pristine-tar \
86 --git-upstream-branch=branch-<version> \ # eg 1.3
87 --git-upstream-tag=<version> # eg 1.3.1
89 ../build-area/altos_<version>.orig.tar.gz \
91 else if this is not a -1 release
94 git tag debian/<version>
96 - at this point we have packages in ~/debian/build-area/altos, now
97 we move on to the non-Debian part of the release process
99 make distclean (just to be sure, this should do nothing)
101 ./autogen.sh --enable-multi-arch \
102 --with-fat-dir=/home/bdale/web/altusmetrum/
105 - store a stable copy of ARM binaries for production use
107 cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin,*.map} \
108 src/easymega-v1.0/{*.elf,*.ihx,*.map} \
109 src/easymega-v2.0/{*.elf,*.ihx,*.map} \
110 src/easymini-v1.0/{*.elf,*.ihx,*.map} \
111 src/easymini-v2.0/{*.elf,*.ihx,*.map} \
112 src/easytimer-v1/{*.elf,*.ihx,*.map} \
113 src/telebt-v3.0/{*.elf,*.ihx,*.map} \
114 src/telebt-v4.0/{*.elf,*.ihx,*.map} \
115 src/teledongle-v3.0/{*.elf,*.ihx,*.map} \
116 src/telegps-v1.0/{*.elf,*.ihx,*.map} \
117 src/telegps-v2.0/{*.elf,*.ihx,*.map} \
118 src/telemega-v[1-4].0/{*.elf,*.ihx,*.map} \
119 src/telemetrum-v2.0/{*.elf,*.ihx,*.map} \
120 src/telemetrum-v3.0/{*.elf,*.ihx,*.map} \
121 src/telemini-v3.0/{*.elf,*.ihx,*.map} \
122 src/telelco-v2.0/{*.elf,*.ihx,*.map} \
123 src/telefireeight-v1.0/{*.elf,*.ihx,*.map} \
124 src/telefireeight-v2.0/{*.elf,*.ihx,*.map} \
125 ~/altusmetrumllc/Binaries/
126 cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin,*.map} \
127 src/easymega-v1.0/flash-loader/*.elf \
128 src/easymega-v2.0/flash-loader/*.elf \
129 src/easymini-v1.0/flash-loader/*.elf \
130 src/easymini-v2.0/flash-loader/{*.elf,*.bin,*.map} \
131 src/easytimer-v1/flash-loader/*.elf \
132 src/telebt-v3.0/flash-loader/*.elf \
133 src/telebt-v4.0/flash-loader/{*.elf,*.bin,*.map} \
134 src/teledongle-v3.0/flash-loader/*.elf \
135 src/telegps-v1.0/flash-loader/*.elf \
136 src/telegps-v2.0/flash-loader/{*.elf,*.bin,*.map} \
137 src/telemega-v[1-4].0/flash-loader/*.elf \
138 src/telemetrum-v2.0/flash-loader/*.elf \
139 src/telemetrum-v3.0/flash-loader/*.elf \
140 src/telemini-v3.0/flash-loader/{*.elf,*.bin,*.map} \
141 src/telelco-v2.0/flash-loader/*.elf \
142 src/telefireeight-v1.0/flash-loader/*.elf \
143 src/telefireeight-v2.0/flash-loader/*.elf \
144 ~/altusmetrumllc/Binaries/loaders/
145 (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
146 - remove previous versions (only keep latest release)
147 (cd ~/altusmetrumllc ; git push)
149 - Push new release to web site
152 (cd doc ; make publish)
154 (cd ~/web/altusmetrum/ && \
155 git add */releases && git commit -m'Release <rev>' && \
156 git push origin master)
158 - upload the Debian package
162 sudo debian/rules clean
163 git push origin master branch-<version> debian pristine-tar
166 Testing before a release
168 To verify that a build works, the following need to be checked
173 2) Connect TM *and* TD devices. Verify that you can Monitor
174 Flight from the TD and Configure Telemetrum from the TM.
176 3) Replay Flight, using your favorite .eeprom file. Check
177 each tab, especially the 'Site Map' tab. Make sure the
180 4) Graph Data. Graph a favorite .eeprom file. Make sure you
181 can zoom in on some region of the graph.