Skip to content

Commit 608033b

Browse files
netelerneteler
committed
howto_release converted to MD incl cleanup (#96)
1 parent 36f472d commit 608033b

2 files changed

Lines changed: 334 additions & 307 deletions

File tree

‎doc/howto_release.md‎

Lines changed: 334 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,334 @@
1+
# How to release GRASS GIS binaries and source code
2+
3+
*Note: Some steps in this text are to be done by the development coordinator (currently Markus Neteler, PSC Chair) due to needed logins.*
4+
5+
## HOWTO create a release
6+
7+
### Preparations
8+
9+
Check examples if still compiling
10+
11+
```bash
12+
( cd doc/raster/r.example/ ; make clean ; make )
13+
( cd doc/vector/v.example/ ; make clean ; make )
14+
```
15+
16+
### Fix typos in source code with
17+
18+
```bash
19+
tools/fix_typos.sh
20+
```
21+
22+
### i18N: sync from Transifex
23+
See https://www.transifex.com/grass-gis/grass7/dashboard/
24+
25+
Exception Latvian as Latvian is directly edited in git and then sync'ed from master .po files
26+
27+
```bash
28+
cd locale
29+
sh ~/software/grass_addons_git/tools/transifex_merge.sh
30+
make
31+
make verify
32+
# ... then fix .po files as needed.
33+
#
34+
# requires https://trac.osgeo.org/grass/ticket/3539
35+
## after that push fixes to transifex:
36+
#cd locale/transifex/
37+
#tx --debug push -t
38+
```
39+
40+
### Update of configure base files
41+
42+
*Only allowed in RC cycle, not for final release!*
43+
44+
Check that autoconf scripts are up-to-date:
45+
```bash
46+
rm -f config.guess config.sub
47+
wget http://git.savannah.gnu.org/cgit/config.git/plain/config.guess
48+
wget http://git.savannah.gnu.org/cgit/config.git/plain/config.sub
49+
git diff config.guess config.sub
50+
autoconf-2.13
51+
```
52+
Now check if configure still works.
53+
54+
If yes, submit to git:
55+
```bash
56+
git add config.guess config.sub configure
57+
git checkout -b config_sub_update_r78
58+
git commit -m"config.guess + config.sub: updated from http://git.savannah.gnu.org/cgit/config.git/plain/" config.guess config.sub configure
59+
# test by running ./configure
60+
61+
git push origin config_sub_update_r78
62+
# open PR and merge
63+
```
64+
65+
### Cleanup leftover rubbish files
66+
67+
```bash
68+
rm -f locale/templates/*.pot
69+
rm -f locale/po/messages.mo
70+
rm -f demolocation/PERMANENT/.bash*
71+
find . -name '*~' | xargs rm
72+
find . -name '*.bak' | xargs rm
73+
find . -name '.#*' | xargs rm
74+
find . -name '*.orig' | xargs rm
75+
find . -name '*.rej' | xargs rm
76+
find . -name '*.o' | xargs rm
77+
find . -name '*.pyc' | xargs rm
78+
find . -name 'OBJ.*' | xargs rm -r
79+
rm -f gui/wxpython/menustrings.py gui/wxpython/build_ext.pyc gui/wxpython/xml/menudata.xml gui/wxpython/xml/module_tree_menudata.xml
80+
chmod -R a+r *
81+
```
82+
83+
Double check:
84+
```bash
85+
git status
86+
```
87+
88+
### Create release branch (only if not yet existing)
89+
90+
.. see section below at end of file.
91+
92+
### Update VERSION file to release version number
93+
94+
TODO: probably better done in GH interface?!
95+
96+
```bash
97+
vim include/VERSION
98+
99+
#example:
100+
7
101+
8
102+
0RC1
103+
2019
104+
```
105+
106+
Cleanup:
107+
```bash
108+
rm -f include/VERSION~
109+
```
110+
111+
~~Update OSGeo4W setup.hint file~~
112+
~~no longer needed~~
113+
~~vim mswindows/osgeo4w/setup_x86.hint.tmpl~~
114+
~~vim mswindows/osgeo4w/setup_x86_64.hint.tmpl~~
115+
116+
### Create release tag
117+
118+
See https://help.github.com/en/articles/creating-releases
119+
120+
Done in GH interface.
121+
122+
### Changelog and tagging etc
123+
124+
```bash
125+
# create version env var for convenience:
126+
MAJOR=`cat include/VERSION | head -1 | tail -1`
127+
MINOR=`cat include/VERSION | head -2 | tail -1`
128+
RELEASE=`cat include/VERSION | head -3 | tail -1`
129+
VERSION=${MAJOR}_${MINOR}_${RELEASE}
130+
echo $VERSION
131+
132+
git checkout -b release_GRASS_GIS_$VERSION
133+
git add include/VERSION
134+
git commit -m"GRASS GIS $VERSION" include/VERSION
135+
git push origin release_GRASS_GIS_$VERSION
136+
137+
# Create Changelog file on release branch:
138+
python tools/gitlog2changelog.py
139+
mv ChangeLog ChangeLog_$VERSION
140+
head ChangeLog_$VERSION
141+
gzip ChangeLog_$VERSION
142+
143+
TODAY=`date +"%Y%m%d"`
144+
RELEASETAG=release_${TODAY}_grass_${MAJOR}_${MINOR}_${RELEASE}
145+
echo $RELEASETAG
146+
```
147+
148+
### Tag release (on GitHub)
149+
150+
```bash
151+
echo "grass_$VERSION"
152+
```
153+
154+
Do this in https://github.com/OSGeo/grass/releases/new
155+
156+
### Packaging of source code tarball
157+
158+
TODO: add checkout of code via release tag
159+
160+
```bash
161+
# create source package (in the source directory):
162+
echo grass-${VERSION}
163+
164+
mkdir grass-${VERSION}
165+
mv * grass-${VERSION}/
166+
# create the package:
167+
tar cvfzh grass-${VERSION}.tar.gz --exclude-vcs grass-${VERSION}/*
168+
# restore src code location:
169+
mv ./grass-${VERSION}/* .
170+
rmdir ./grass-${VERSION}
171+
# Calculating MD5 sum:
172+
md5sum grass-${VERSION}.tar.gz > grass-${VERSION}.md5sum
173+
```
174+
175+
### Reset include/VERSION file to git version:
176+
177+
TODO: probably better done in GH interface
178+
179+
```bash
180+
vim include/VERSION
181+
182+
#example
183+
7
184+
8
185+
0dev
186+
2019
187+
188+
rm -f include/VERSION~
189+
git checkout -b back_to_git_dev
190+
git add include/VERSION
191+
git commit -m"back to git" include/VERSION
192+
git push origin back_to_git_dev
193+
# open PR and merge
194+
```
195+
196+
### Upload source code tarball to OSGeo servers
197+
198+
```bash
199+
# Store the source tarball (twice) in (use scp -p FILES grass:):
200+
SERVER1=grass.osgeo.org
201+
SERVER1DIR=/var/www/grass/grass-cms/grass$MAJOR$MINOR/source/
202+
SERVER2=upload.osgeo.org
203+
SERVER2DIR=/osgeo/download/grass/grass$MAJOR$MINOR/source/
204+
echo $SERVER1:$SERVER1DIR
205+
echo $SERVER2:$SERVER2DIR
206+
207+
# upload along with associated files:
208+
scp -p grass-$VERSION.* AUTHORS COPYING ChangeLog_$VERSION.gz \
209+
INSTALL REQUIREMENTS.html SUBMITTING neteler@$SERVER1:$SERVER1DIR
210+
211+
scp -p grass-$VERSION.* AUTHORS COPYING ChangeLog_$VERSION.gz \
212+
INSTALL REQUIREMENTS.html SUBMITTING neteler@$SERVER2:$SERVER2DIR
213+
214+
# Only at full release!
215+
# generate link to "latest" source code
216+
ssh neteler@$SERVER1 "cd $SERVER1DIR ; rm -f grass-$MAJOR.$MINOR-latest.tar.gz"
217+
ssh neteler@$SERVER1 "cd $SERVER1DIR ; ln -s grass-$VERSION.tar.gz grass-$MAJOR.$MINOR-latest.tar.gz"
218+
219+
# update winGRASS related files: Update the winGRASS version
220+
vim grass-addons/tools/wingrass-packager/grass_packager_release.bat
221+
vim grass-addons/tools/wingrass-packager/grass_addons.sh
222+
vim grass-addons/tools/wingrass-packager/grass_copy_wwwroot.sh
223+
vim grass-addons/tools/wingrass-packager/cronjob.sh # major/minor release only
224+
225+
# update addons - major/minor release only
226+
vim grass-addons/tools/addons/grass-addons-publish.sh
227+
vim grass-addons/tools/addons/grass-addons-build.sh
228+
vim grass-addons/tools/addons/grass-addons.sh
229+
```
230+
231+
Release is done.
232+
233+
### Advertise new release
234+
235+
#### Update CMS web site to show new version
236+
237+
- News section
238+
- https://grass.osgeo.org/download/software/
239+
- https://grass.osgeo.org/download/software/sources/
240+
- https://grass.osgeo.org/download/software/linux/
241+
- https://grass.osgeo.org/home/history/releases/
242+
243+
TODO: git tags
244+
- https://grass.osgeo.org/development/svn/svn-tags/ (add tag): echo $RELEASETAG
245+
246+
#### Write announcement and publish it
247+
- store in trac:
248+
- https://trac.osgeo.org/grass/wiki/Release/7.8.x-News
249+
- https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures78 <- add content of major changes only
250+
- update version in https://grasswiki.osgeo.org/wiki/GRASS-Wiki
251+
- ~~store in Web as announces/announce_grass$MAJOR$MINOR$RELEASE.html <- how? with protected PHP upload page?~~ (dropped since CMS)
252+
253+
#### Only when new major release
254+
- update cronjob 'cron_grass_HEAD_src_snapshot.sh' on grass.osgeo.org to next but one release tag for the differences
255+
- wiki updates, only when new major release:
256+
- {{cmd|xxxx}} macro: https://grasswiki.osgeo.org/wiki/Template:Cmd
257+
- update last version on main page
258+
- trac updates, only when new major release:
259+
- Set "complete" flag in https://trac.osgeo.org/grass/milestone/7.8.x --> Edit Milestone
260+
- also: Retarget associated open tickets to milestone 7.8.x
261+
- Batch modify tickets, set to next milestone (update this query accordingly: two entries to change):
262+
- https://trac.osgeo.org/grass/query?status=assigned&status=new&status=reopened&milestone=7.8.0&milestone=7.8.1&group=status&col=id&col=summary&col=owner&col=type&col=priority&col=component&col=version&order=priority
263+
- Set max items to 1000, then select all shown tickets via Status: assigned/new/reopened sections
264+
- Scroll down to "Batch modify": under the "Comment" section, add Field "Milestone" and set to next version
265+
- then use "Change ticket" button, done.
266+
- Only in case of new release branch being created:
267+
- Add Wiki Macro definitions for manual pages G7X:modulename
268+
- Edit: https://trac.osgeo.org/grass/wiki/InterMapTxt
269+
270+
#### WinGRASS notes
271+
- Update grass_packager_release.bat, eg.
272+
```
273+
set MAJOR=7
274+
set MINOR=8
275+
set PATCH=0RC1
276+
```
277+
- Update addons (grass_addons.sh) rules, eg.
278+
```
279+
compile $GIT_PATH/grass7 $GISBASE_PATH/grass780RC1 $ADDON_PATH/grass780RC1/addons
280+
```
281+
- Modify grass_copy_wwwroot.sh accordingly, eg.
282+
```
283+
copy_addon 781RC1 7.8.1RC1
284+
```
285+
286+
#### Launchpad notes:
287+
- Create milestone and release: https://launchpad.net/grass/+series
288+
- Upload tarball for created release
289+
- Update daily recipe contents: https://code.launchpad.net/~grass/+recipe/grass-trunk
290+
291+
#### Packaging notes:
292+
- https://trac.osgeo.org/grass/wiki/BuildHints
293+
- https://trac.osgeo.org/grass/wiki/DebianUbuntuPackaging
294+
- https://trac.osgeo.org/grass/wiki/CompileOnWindows
295+
296+
#### Marketing - tell others about release:
297+
- Notify all packagers (MN has email list)
298+
- If release candidate:
299+
- <grass-announce@lists.osgeo.org>
300+
- <grass-dev@lists.osgeo.org>
301+
- If official release:
302+
- publish related announcement press release at:
303+
- Our GRASS web site: /announces/
304+
- Note: DON'T use relative links there
305+
- Our main mailing lists:
306+
- http://lists.osgeo.org/mailman/listinfo/grass-announce | <grass-announce@lists.osgeo.org>
307+
- http://lists.osgeo.org/mailman/listinfo/grass-dev | <grass-dev@lists.osgeo.org>
308+
- http://lists.osgeo.org/mailman/listinfo/grass-user | <grass-user@lists.osgeo.org>
309+
- DebianGIS: <debian-gis@lists.debian.org> - send only small note
310+
- FreeGIS: <freegis-list@intevation.de>
311+
- Geowanking: <geowanking@geowanking.org>
312+
- OSGeo.org: <news_item@osgeo.org>
313+
314+
Via Email:
315+
- info@osgeo.org
316+
- http://www.gis-news.de/ (franz-josef.behr@gismngt.de)
317+
- http://spatialnews.geocomm.com/submitnews.html (not free any more, convince editor@geocomm.com)
318+
- mfeilner@linuxnewmedia.de
319+
- info@harzer.de
320+
- editor-geo@geoconnexion.com
321+
322+
Via Web:
323+
- https://plus.google.com/u/0/communities/111147786674687562495 (G+ GRASS GIS community)
324+
- http://linuxtoday.com/contribute.php3
325+
- https://joinup.ec.europa.eu/software/grassgis/home (submit news, MN)
326+
- http://www.macnn.com/contact/newstips/1
327+
- http://www10.giscafe.com/submit_material/submit_options.php#Press (MN) --> Press releases
328+
- http://www.directionsmag.com/pressreleases/ (News -> Submit Press Release)
329+
- http://directory.fsf.org/wiki/GRASS_%28Geographic_Resources_Analysis_Support_System%29
330+
- https://www.linux-apps.com/p/1128004/edit/ (MN)
331+
- https://news.eoportal.org/web/eoportal/share-your-news (MN) -> Share your news with the EO community
332+
- https://www.heise.de/download/product/grass-gis-7105 (update, MN)
333+
- See also: https://grass.osgeo.org/wiki/Contact_Databases
334+
- ... anywhere else? Please add here.

0 commit comments

Comments
 (0)