a570645a860ab67252902115ca349ce33c9f3a03
[fw/altos] / Releasing
1 These are Bdale's notes on how to do a release.
2
3         - make sure build environment is up to date
4                 sudo cowbuilder --update
5
6         git checkout master
7
8         - update the version in configure.ac if Keith hasn't already
9
10         - make sure the Google Maps API key is in the build chroot and root
11             sudo mkdir -p /var/cache/pbuilder/base.cow/opt/google /opt/google
12             sudo cp ~/altusmetrumllc/google-maps-api-key \
13                 /var/cache/pbuilder/base.cow/opt/google/maps-api-key
14             sudo ln -sf /home/bdale/altusmetrumllc/google-maps-api-key \
15                 /opt/google/maps-api-key
16
17         - if this is an x.y release, then:
18                 git checkout -b branch-<version>
19
20         - if this is an x.y.z release, then:
21                 git checkout branch-<version>           # the x.y parts only
22                 - cherry-pick or merge appropriate content from master
23         
24         - make sure there is a doc/release-notes-<version>.xsl
25         - make sure that doc/altusmetrum.xsl has the right copyright year,
26           and add release to the revision history at the front (release notes
27           will be pulled in automatically)
28         - make absolutely sure checked-out tree is "clean" 
29         - make absolutely sure the pdclib/ submodule is on the master branch,
30           up to date, and "clean"
31
32         git log > ChangeLog
33         git commit -a
34         git tag -a <version>                    # full x.y.z version
35
36         - make sure .git/gbp.conf set to use branch-<version> as upstream
37
38         git checkout debian
39         git merge branch-<version>
40
41         - verify debian/changelog is "clean" ending in last release version
42         - craft a suitable debian/changelog entry, possibly using:
43         gbp dch --release --new-version=<version>-1 --multimaint-merge
44
45         git commit -n debian/changelog -m "update changelog for Debian build"
46
47         - if this is a -1 release, then
48                 gbp buildpackage --git-no-pristine-tar --git-submodules \
49                         --git-upstream-branch=branch-<version> \ # eg 1.3
50                         --git-upstream-tag=<version>             # eg 1.3.1
51                 pristine-tar commit \
52                         ../build-area/altos_<version>.orig.tar.gz \
53                         branch-<version>
54           else if this is not a -1 release
55                 gbp buildpackage --git-submodules
56
57         git tag debian/<version>
58
59         - at this point we have packages in ~/debian/build-area/altos, now
60           we move on to the non-Debian part of the release process
61
62         make distclean
63
64         ./autogen.sh --enable-multi-arch \
65                 --with-fat-dir=/home/bdale/web/altusmetrum/AltOS/releases
66         make && make fat
67
68                 this pushes packages for each platform to web site
69
70         # store a stable copy of ARM binaries for production use
71         cp src/easymega-v1.0/*.elf \
72            src/easymini-v1.0/*.elf \
73            src/telebt-v3.0/*.elf \
74            src/teledongle-v3.0/*.elf \
75            src/telegps-v1.0/*.elf \
76            src/telemega-v1.0/*.elf \
77            src/telemetrum-v2.0/*.elf \
78            ~/altusmetrumllc/Binaries/
79         cp src/easymega-v1.0/flash-loader/*.elf \
80            src/easymini-v1.0/flash-loader/*.elf \
81            src/telebt-v3.0/flash-loader/*.elf \
82            src/teledongle-v3.0/flash-loader/*.elf \
83            src/telegps-v1.0/flash-loader/*.elf \
84            src/telemega-v1.0/flash-loader/*.elf \
85            src/telemetrum-v2.0/flash-loader/*.elf \
86            ~/altusmetrumllc/Binaries/loaders/
87         (cd ~/altusmetrumllc ; git add Binaries ; git commit -a) 
88         (cd ~/altusmetrumllc ; git push) 
89
90         - copy the relevant release notes file from doc/ to 
91             /home/bdale/web/altusmetrum/AltOS/releases/<rev>
92
93         (cd ~/web/altusmetrum/AltOS/releases/<rev> ; rm *.tar.bz2)
94
95         - create /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>,
96           and move the MicroPeak installers from AltOS/releases to there
97                 
98         - create /home/bdale/web/altusmetrum/TeleGPS/releases/<rev>,
99           and move the TeleGPS installers from AltOS/releases to there
100                 
101         - go edit ~/web/altusmetrum/AltOS/releases/<rev>.mdwn, 
102           /home/bdale/web/altusmetrum/MicroPeak/releases/<rev>.mdwn, and
103           /home/bdale/web/altusmetrum/TeleGPS/releases/<rev>.mdwn
104
105                 - make sure the Windows stuff is like 1-4-1, not 1.4.1!
106
107         (cd doc ; make publish)
108
109                 this pushes fresh documents to the web site
110
111         sudo debian/rules clean
112         git push origin master branch-<version> debian pristine-tar
113         git push --tags
114
115                 push commits and leave the build tree in an uncluttered state
116
117 Testing before a release
118
119         To verify that a build works, the following need to be checked
120         on each platform:
121
122         1) Install package
123
124         2) Connect TM *and* TD devices. Verify that you can Monitor
125            Flight from the TD and Configure Telemetrum from the TM.
126
127         3) Replay Flight, using your favorite .eeprom file. Check
128            each tab, especially the 'Site Map' tab. Make sure the
129            sound works.
130
131         4) Graph Data. Graph a favorite .eeprom file. Make sure you
132            can zoom in on some region of the graph.