summaryrefslogtreecommitdiff
path: root/Releasing
blob: 5780f3ce2778ce4e9318d58259cf083df3b548d8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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

	- 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.

	- make sure build environment is up to date
		sudo cowbuilder --update

	git checkout master

	- update the version in configure.ac if Keith hasn't already

	- make sure the Google Maps API key is in the build chroot and root
	    (cd ~/altusmetrumllc; git pull)
	    sudo mkdir -p /var/cache/pbuilder/base.cow/opt/google /opt/google
	    sudo cp ~/altusmetrumllc/google-maps-api-key \
		/var/cache/pbuilder/base.cow/opt/google/maps-api-key
	    sudo ln -sf /home/bdale/altusmetrumllc/google-maps-api-key \
		/opt/google/maps-api-key

	- if this is an x.y release, then:
		git checkout -b branch-<version>

	- if this is an x.y.z release, then:
		git checkout branch-<version>		# the x.y parts only
		- 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:
	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
		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
		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

	./autogen.sh --enable-multi-arch \
		--with-fat-dir=/home/bdale/web/altusmetrum/
	make && make fat

		this pushes packages for each platform and application
		to web site, including auto-generated mdwn files and
		release notes in html format.

	# store a stable copy of ARM binaries for production use
	cp src/chaoskey-v1.0/{*.elf,*.ihx} \
	   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/telemega-v1.0/{*.elf,*.ihx} \
	   src/telemega-v2.0/{*.elf,*.ihx} \
	   src/telemetrum-v2.0/{*.elf,*.ihx} \
	   src/telemini-v3.0/{*.elf,*.ihx} \
	   ~/altusmetrumllc/Binaries/
	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 \
	   src/teledongle-v3.0/flash-loader/*.elf \
	   src/telegps-v1.0/flash-loader/*.elf \
	   src/telemega-v1.0/flash-loader/*.elf \
	   src/telemega-v2.0/flash-loader/*.elf \
	   src/telemetrum-v2.0/flash-loader/*.elf \
	   src/telemini-v3.0/flash-loader/{*.elf,*.bin} \
	   ~/altusmetrumllc/Binaries/loaders/
	(cd ~/altusmetrumllc ; git add Binaries ; git commit -a) 
	(cd ~/altusmetrumllc ; git push) 

	- copy the relevant release notes .html file from doc/ to 
	    /home/bdale/web/altusmetrum/AltOS/releases/<rev>

	- Push new release to web site

	make fat-install
	(cd doc ; make publish)

	(cd ~/web/altusmetrum/ && git add AltOS/releases
	TeleGPS/releases MicroPeak/releases && git commit -m'Release
	<rev>' && git push origin master)

		this pushes fresh documents to the web site

	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
	on each platform:

	1) Install package

	2) Connect TM *and* TD devices. Verify that you can Monitor
	   Flight from the TD and Configure Telemetrum from the TM.

	3) Replay Flight, using your favorite .eeprom file. Check
	   each tab, especially the 'Site Map' tab. Make sure the
	   sound works.

	4) Graph Data. Graph a favorite .eeprom file. Make sure you
	   can zoom in on some region of the graph.