+Adding a product to the release
+
+ Make sure the firmware and loader get built by default in
+ src/Makefile
+
+ Add the firmware to altosui/Makefile.am
+
+ Add the firmware to altosui/altos-windows.nsi.in
+
+ Add the firmware to telegps/Makefile.am
+
+ Add the firmware to telegps/telegps-windows.nsi.in
+
+ Add the firmware to Releasing
+
+These are Keith's notes on how to do a release
+
+ - update the version and date in configure.ac if Bdale hasn't already
+
+ - follow instructions in doc/RELNOTES
+
+ - make sure there is a doc/release-notes-<version>.inc
+
+ - make sure doc/release-notes.inc points at that
+
+ - make sure doc/Makefile points at that too
+
+ - make sure that doc/altusmetrum-docinfo.xml has the right copyright
+ year, and add release to the revision history at the front (release
+ notes will be pulled in by release-notes.inc)
+
These are Bdale's notes on how to do a release.
- git checkout master
+ - make sure build environment is up to date
+ sudo cowbuilder --update
- - make sure there is a doc/release-notes-<version>.xsl
- - make sure that doc/altusmetrum.xsl has the right copyright year,
- and add release to the revision history at the front (release notes
- will be pulled in automatically)
+ - ensure i386 build support is available, and we have tools to build
+ installers for Windows and Mac OS X
- - get a Google Maps API key and install it in
- ~/altusmetrumllc/google-maps-api-key. If you don't have a
- key, the app will still work, but downloading map tiles will
- be slow, and you will only be able to download a limited
- number per day.
+ sudo dpkg --add-architecture i386
+ sudo apt update
+ sudo apt install gcc-multilib genisoimage nsis
+ (need some mingw packages too, but not sure which offhand)
- - update the version in configure.ac
- git log > ChangeLog
- git commit -a
+ - make sure ~/web/altusmetrum has no pending pullable commits
- - make absolutely sure checked-out tree is "clean"
- - make absolutely sure the pdclib/ submodule is on the master branch,
- up to date, and "clean"
+ git checkout master
+
+ - update the version in configure.ac if Keith hasn't already
- if this is an x.y release, then:
git checkout -b branch-<version>
- git tag -a <version>
- - edit .git/gbp.conf to use branch-<version> as upstream
- if this is an x.y.z release, then:
git checkout branch-<version> # the x.y parts only
- git merge master
- git tag -a <version> # full x.y.z version
+ - cherry-pick or merge appropriate content from master
+
+ - make sure there is a doc/release-notes-<version>.inc
+ - make sure that doc/altusmetrum-docinfo.xml has the right copyright
+ year, and add release to the revision history at the front (release
+ notes will be pulled in automatically)
+ - make absolutely sure checked-out tree is "clean"
+ - make absolutely sure the pdclib/ submodule is on the master branch,
+ up to date, and "clean"
+
+ git log > ChangeLog
+ git commit -a
+ git tag -a <version> # full x.y.z version
+
+ - make sure .git/gbp.conf set to use branch-<version> as upstream
git checkout debian
git merge branch-<version>
- verify debian/changelog is "clean" ending in last release version
- craft a suitable debian/changelog entry, possibly using:
- git-dch --release --new-version=<version>-1 --multimaint-merge
+ gbp dch --release --multimaint-merge --new-version=<version>-1
git commit -n debian/changelog -m "update changelog for Debian build"
- if this is a -1 release, then
- git-buildpackage --git-no-pristine-tar --git-submodules \
+ gbp buildpackage --git-no-pristine-tar --git-submodules \
--git-upstream-branch=branch-<version> \ # eg 1.3
--git-upstream-tag=<version> # eg 1.3.1
pristine-tar commit \
../build-area/altos_<version>.orig.tar.gz \
branch-<version>
else if this is not a -1 release
- git-buildpackage --git-submodules
+ gbp buildpackage --git-submodules
git tag debian/<version>
- at this point we have packages in ~/debian/build-area/altos, now
we move on to the non-Debian part of the release process
- make distclean
+ make distclean (just to be sure, this should do nothing)
- ./autogen.sh --with-fat-dir=/home/bdale/web/altusmetrum/AltOS/releases
+ ./autogen.sh --enable-multi-arch \
+ --with-fat-dir=/home/bdale/web/altusmetrum/
make && make fat
- this pushes packages for each platform to web site
-
- # store a stable copy of ARM binaries for production use
- cp src/easymini-v1.0/*.elf \
- src/telegps-v1.0/*.elf \
- src/telemega-v1.0/*.elf \
- src/telemetrum-v2.0/*.elf \
+ - store a stable copy of ARM binaries for production use
+
+ cp src/chaoskey-v1.0/{*.elf,*.ihx,*.bin} \
+ src/easymega-v1.0/{*.elf,*.ihx} \
+ src/easymini-v1.0/{*.elf,*.ihx} \
+ src/easymini-v2.0/{*.elf,*.ihx} \
+ src/telebt-v3.0/{*.elf,*.ihx} \
+ src/telebt-v4.0/{*.elf,*.ihx} \
+ src/teledongle-v3.0/{*.elf,*.ihx} \
+ src/telegps-v1.0/{*.elf,*.ihx} \
+ src/telegps-v2.0/{*.elf,*.ihx} \
+ src/telemega-v1.0/{*.elf,*.ihx} \
+ src/telemega-v2.0/{*.elf,*.ihx} \
+ src/telemega-v3.0/{*.elf,*.ihx} \
+ src/telemetrum-v2.0/{*.elf,*.ihx} \
+ src/telemini-v3.0/{*.elf,*.ihx} \
+ src/telelco-v2.0/{*.elf,*.ihx} \
+ src/telefireeight-v1.0/{*.elf,*.ihx} \
~/altusmetrumllc/Binaries/
- cp src/easymini-v1.0/flash-loader/*.elf \
+ cp src/chaoskey-v1.0/flash-loader/{*.elf,*.bin} \
+ src/easymega-v1.0/flash-loader/*.elf \
+ src/easymini-v1.0/flash-loader/*.elf \
+ src/easymini-v2.0/flash-loader/{*.elf,*.bin} \
+ src/telebt-v3.0/flash-loader/*.elf \
+ src/telebt-v4.0/flash-loader/{*.elf,*.bin} \
+ src/teledongle-v3.0/flash-loader/*.elf \
src/telegps-v1.0/flash-loader/*.elf \
+ src/telegps-v2.0/flash-loader/{*.elf,*.bin} \
src/telemega-v1.0/flash-loader/*.elf \
+ src/telemega-v2.0/flash-loader/*.elf \
+ src/telemega-v3.0/flash-loader/*.elf \
src/telemetrum-v2.0/flash-loader/*.elf \
+ src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
+ src/telelco-v2.0/flash-loader/*.elf \
+ src/telefireeight-v1.0/flash-loader/*.elf \
~/altusmetrumllc/Binaries/loaders/
- (cd ~/altusmetrumllc ; git commit -a)
+ (cd ~/altusmetrumllc ; git add Binaries ; git commit -a)
+ - remove previous versions (only keep latest release)
+ (cd ~/altusmetrumllc ; git push)
- - copy the relevant release notes file from doc/ to
- /home/bdale/web/altusmetrum/AltOS/releases/<rev>
-
- - create /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>,
- and move the MicroPeak installers from AltOS/releases to there
-
- - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn and
- /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>.mdwn, to
- include release date and explicit ref to dir contents so the
- web pages shows versioned links, commit and push
+ - Push new release to web site
+ make fat-install
(cd doc ; make publish)
- this pushes fresh documents to the web site
+ (cd ~/web/altusmetrum/ && \
+ git add */releases && git commit -m'Release <rev>' && \
+ git push origin master)
+
+ - upload the Debian package
+
+ - clean up
sudo debian/rules clean
git push origin master branch-<version> debian pristine-tar
git push --tags
- push commits and leave the build tree in an uncluttered state
-
Testing before a release
To verify that a build works, the following need to be checked
projects / fw / altos / blobdiff