altos: Add initial micropeak implementation
[fw/altos] / Releasing
1 These are Bdale's notes on how to do a release.
2
3         git checkout master
4
5         - make sure there is a doc/release-notes-<version>.xsl
6         - make sure that doc/altusmetrum.xsl has the right copyright year,
7           and add release to the revision history at the front (release notes
8           will be pulled in automatically)
9
10         - update the version in configure.ac
11         git log > ChangeLog
12         git commit -a
13         - make absolutely sure checked-out tree is "clean" 
14         - if this is an x.y release, then:
15                 git checkout -b branch-<version>
16                 git tag -a <version>
17         - if this is an x.y.z release, then:
18                 git checkout branch-<version>           # the x.y parts only
19                 git merge master
20                 git tag -a <version>                    # full x.y.z version
21
22         - edit .git/gbp.conf to use branch-<version> as upstream if needed
23
24         git checkout debian
25         git merge branch-<version>
26
27         - verify debian/changelog is "clean" ending in last release version
28         - craft a suitable debian/changelog entry, possibly using:
29         git-dch --release --new-version=<version>-1 --multimaint-merge
30
31         git commit -n debian/changelog -m "update changelog for Debian build"
32
33         - if this is a -1 release, then
34                 git-buildpackage --git-no-pristine-tar 
35                 pristine-tar commit \
36                         ../build-area/altos/altos_<version>.orig.tar.gz \
37                         branch-<version>
38           else if this is not a -1 release
39                 git-buildpackage
40
41         git tag debian/<version>
42
43         - at this point we have packages in ~/debian/build-area/altos, now
44           we move on to the non-Debian part of the release process
45
46         make distclean
47
48         ./autogen.sh --with-fat-dir=/home/bdale/web/altusmetrum/AltOS/releases
49         make && make fat
50
51                 this pushes packages for each platform to web site
52
53         - copy the relevant release notes file from doc/ to 
54             /home/bdale/web/altusmetrum/AltOS/releases/<rev>
55
56         - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn to include
57           release date and explicit ref to dir contents so the AltOS page
58           shows versioned links, commit and push
59
60         (cd doc ; make publish)
61
62                 this pushes fresh documents to the web site
63
64         sudo debian/rules clean
65         git push origin master branch-1.1 debian
66         git push --tags
67
68                 push commits and leave the build tree in an uncluttered state
69
70 Testing before a release
71
72         To verify that a build works, the following need to be checked
73         on each platform:
74
75         1) Install package
76
77         2) Connect TM *and* TD devices. Verify that you can Monitor
78            Flight from the TD and Configure Telemetrum from the TM.
79
80         3) Replay Flight, using your favorite .eeprom file. Check
81            each tab, especially the 'Site Map' tab. Make sure the
82            sound works.
83
84         4) Graph Data. Graph a favorite .eeprom file. Make sure you
85            can zoom in on some region of the graph.