parallel: Better error message if 'rsync' is not in $PATH.
[parallel.git] / doc / release_new_version
blob7b73c82274dc13b897865d16f0abd2e7b6d45272
1 # SPDX-FileCopyrightText: 2021-2022 Ole Tange, http://ole.tange.dk and Free Software and Foundation, Inc.
2 # SPDX-License-Identifier: GFDL-1.3-or-later
3 # SPDX-License-Identifier: CC-BY-SA-4.0
5 = Notes on how to release new version =
7 == alpha/beta/production ==
9 Check that documentation is updated (compare to web):
11 git grep -E '(alpha|beta) testing' | cat
12 git diff $(date --date="last month" +%Y%m22)
13 Unmodified beta since last version => production
14 Unmodified alpha since last version => beta
15 Modified => alpha
17 == Update NEWS ==
19 With the same things that goes in the announce mail
21 == Testsuite ==
23 Start termux on Android
24 Start: wssh mac ping fi.dk
25 cd testsuite; make mem; make polar; make long; make short
27 == Update version ==
29 https://zenodo.org/deposit/new
31 (*) Software
32 (Reserve DOI)
33 GNU Parallel 20xxxx22 ('Xxxx')
34 Tange, Ole
35 https://orcid.org/0000-0002-6345-1437
36 Description
37 GNU Parallel is a general parallelizer to run multiple serial command line programs in parallel without changing them.
39 License:
40 gpl v3
42 [Save]
45 10.5281/zenodo.4381888
46 DOINO=3956817
47 SPCTAG='Privacy Shield'
49 # Update version
50 . packager/releasescripts/updateversion
52 # Load doi+tag in other window
53 . .last-doitag.txt
55 === Reconfig autoconf/automake, build tar.bz2 and test it ===
57 . .last-doitag.txt
58 make reconf &&
59 make pack_unpack_and_test_build
61 == Upload ==
63 . .last-doitag.txt
64 eval `gpg-agent --daemon`
65 # Takes up to 8 minutes
66 make upload
68 # Only needed for alpha:
69 . .last-doitag.txt
70 eval `gpg-agent --daemon`
71 # Takes up to 8 minutes
72 make alphaupload
74 == Update OpenSUSE build system ==
76 . .last-doitag.txt
77 cd ~/privat/parallel/packager/obs
79 find home-tange/parallel/* -type f |
80   grep -Ev '(PKGBUILD|parallel.spec)' |
81   parallel -j1 'osc rm {} || rm {}'
82 # This should not create new files
83 osc up home-tange/parallel/
84 make
85 # Reload build-status:
86 https://build.opensuse.org/package/show/home:tange/parallel
87 # Check that one .deb (Debian 5.0) and one .rpm (CentOS) end with 'succeeded'
89 == Upload LBRY ==
91 lbry://@GnuParallel#4/parallel-20210322.tar.bz2
93 # An easy way to support GNU Parallel is to tip on LBRY.
94
95 # :
96
97 # If you like GNU Parallel record a video testimonial: Say who you are, what you use GNU Parallel for, how it helps you, and what you like most about it. Include a command that uses GNU Parallel if you feel like it.
98
99 # Thumbnail: https://www.gnu.org/software/parallel/logo-gray+black10000.png
101 # Tags: gnu parallel software
103 . .last-doitag.txt
104 file_path="`pwd`/parallel-$YYYYMMDD.tar.bz2"
105 title="GNU Parallel $YYYYMMDD ('$SPCTAG')"
106 name="GNU-Parallel-$YYYYMMDD-$TAG"
107 author="Ole Tange"
108 license="GNU GPLv3 or later"
109 thumbnail_url=https://www.gnu.org/software/parallel/logo-gray+black10000.png
110 channel_name="@GnuParallel"
111 tags_opt='--tag gnu --tag parallel --tag free --tag software'
113 description="An easy way to support GNU Parallel is to tip on LBRY.
115 $(perl -ne '/About\sGNU\sParallel/ and exit;/It\sis\savailable/..0 and print' doc/release_new_version)
117 echo "$description" | grep '<<.*>>' && echo STOP STOP STOP
118 echo "$description"
120 lbrynet publish \
121   --bid=0.01 \
122   --file_path="$file_path" \
123   --name="$name" \
124   --title="$title" \
125   --description="$description" \
126   --author="$author" \
127   $languages_opt \
128   $tags_opt \
129   --license="$license" \
130   --thumbnail_url="$thumbnail_url" \
131   --channel_name="$channel_name" \
133 #  --release_time="$release_time" \
135 == Update website ==
137 http://www.gnu.org/software/parallel/
138 http://www.gnu.org/software/parallel/man.html
139 http://www.gnu.org/software/parallel/sql.html
140 http://www.gnu.org/software/parallel/sem.html
141 http://www.gnu.org/software/parallel/env_parallel.html
142 http://www.gnu.org/software/parallel/parcat.html
143 http://www.gnu.org/software/parallel/parset.html
144 http://www.gnu.org/software/parallel/parsort.html
145 http://www.gnu.org/software/parallel/niceload.html
147 make web
148 cp -r src/*.pdf src/sphinx/build/html/* ../parallel-web/parallel
149 cp ../parallel-web/parallel/parallel.html  ../parallel-web/parallel/man.html
151 pushd ../parallel-web/parallel
152 # Bug at Savannah makes this take 30 seconds
153 (cd ..;
154  torsocks cvs -z3 -d:ext:tange@cvs.savannah.gnu.org:/web/parallel co parallel)
155 torsocks cvs up
156 torsocks cvs ci -m "New release"
157 pushd
159 == Commit released version ==
161 git diff
163 # Recheck OBS https://build.opensuse.org/package/show/home:tange/parallel
165 . .last-doitag.txt
166 echo "Released as $YYYYMMDD ('$TAG')." | grep MyTag && (STOP;STOP;STOP)
167 echo "$TAG" | grep ' ' && (STOP;STOP;STOP)
168 echo "Released as $YYYYMMDD ('$SPCTAG')."
170 git commit -a -m "Released as $YYYYMMDD ('$SPCTAG')"
171 git tag -s -u 88888888 -m "Released as $YYYYMMDD ('$SPCTAG')" $TAG
172 git tag -s -u 88888888 -m "Released as $YYYYMMDD ('$SPCTAG')" $YYYYMMDD
174 torsocks git push
175 torsocks git push origin $TAG
176 torsocks git push origin $YYYYMMDD
178 == Zenodo ==
180 Add tar.bz2 [Start upload] and [Publish].
182 == Update documentation ==
184 Update version number + 1
186 export YYYYMMDD=`yyyymmdd`
187 export YYYYMMDD=${YYYYMMDD:0:6}23
188 echo $YYYYMMDD
189 perl -i -pe "/version/ and s/20\d\d\d\d\d\d/$YYYYMMDD/" src/parallel
190 perl -i -pe "/version/ and s/20\d\d\d\d\d\d/$YYYYMMDD/" src/sql
191 perl -i -pe "/version/ and s/20\d\d\d\d\d\d/$YYYYMMDD/" src/env_parallel*
192 perl -i -pe "/version/ and s/20\d\d\d\d\d\d/$YYYYMMDD/" src/parsort
193 perl -i -pe "/version/ and s/20\d\d\d\d\d\d/$YYYYMMDD/" src/niceload
195 Unmodified beta since last version => production
196 Unmodified alpha since last version => beta
197 Modified => alpha
200 == Check URLs ==
202 make testurls
204 == Check REUSE ==
206 make reuse
208 https://api.reuse.software/info/git.savannah.gnu.org/git/parallel
209 https://api.reuse.software/status/git.savannah.gnu.org/git/parallel
211 == Update Savannah ==
213 file:///home/tange/privat/parallel/doc/release_new_version
215 Content from release mail:
217 https://savannah.gnu.org/news/submit.php?group=parallel
219 Test URLs.
221 https://savannah.gnu.org/news/approve.php?group=parallel
223 == Update Freshmeat ==
225 // FreeCode is dying
226 http://freshmeat.net/projects/parallel/releases/new
228 == Update Diaspora Twitter ==
230 https://joindiaspora.com/stream
232 New release of #GNU Parallel pi.dk/0
233 New in this release pi.dk/2
234 See the intro videos pi.dk/1
235 10 secs installation: https://git.savannah.gnu.org/cgit/parallel.git/tree/README
237 Aspect: Public
239 GNU Parallel - for people who live life in the parallel lane.
241 == Send announce ==
243 http://groups.google.com/group/comp.unix.shell/post
244 http://groups.google.com/group/comp.unix.admin/post
246 https://lists.gnu.org/mailman/admindb/bug-parallel
247 https://lists.gnu.org/mailman/admindb/parallel
249 file:///home/tange/privat/parallel/doc/release_new_version
251 For codename look at https://www.onthisday.com/
253 from:tange@gnu.org
254 to:parallel@gnu.org, bug-parallel@gnu.org
255 stable-bcc: Jesse Alama <jessealama@fastmail.fm>
257 Subject: GNU Parallel 20220822 ('<<>>') released
259 GNU Parallel 20220822 ('<<>>') has been released. It is available for download at: lbry://@GnuParallel:4
261 Quote of the month:
263   <<>>
265   
266 New in this release:
268 <<>>
270 * Bug fixes and man page updates.
272 News about GNU Parallel:
274 <<>>
277 GNU Parallel - For people who live life in the parallel lane.
279 If you like GNU Parallel record a video testimonial: Say who you are, what you use GNU Parallel for, how it helps you, and what you like most about it. Include a command that uses GNU Parallel if you feel like it.
282 = About GNU Parallel =
284 GNU Parallel is a shell tool for executing jobs in parallel using one or more computers. A job can be a single command or a small script that has to be run for each of the lines in the input. The typical input is a list of files, a list of hosts, a list of users, a list of URLs, or a list of tables. A job can also be a command that reads from a pipe. GNU Parallel can then split the input and pipe it into commands in parallel.
286 If you use xargs and tee today you will find GNU Parallel very easy to use as GNU Parallel is written to have the same options as xargs. If you write loops in shell, you will find GNU Parallel may be able to replace most of the loops and make them run faster by running several jobs in parallel. GNU Parallel can even replace nested loops.
288 GNU Parallel makes sure output from the commands is the same output as you would get had you run the commands sequentially. This makes it possible to use output from GNU Parallel as input for other programs.
290 For example you can run this to convert all jpeg files into png and gif files and have a progress bar:
292   parallel --bar convert {1} {1.}.{2} ::: *.jpg ::: png gif
294 Or you can generate big, medium, and small thumbnails of all jpeg files in sub dirs:
296   find . -name '*.jpg' |
297     parallel convert -geometry {2} {1} {1//}/thumb{2}_{1/} :::: - ::: 50 100 200
299 You can find more about GNU Parallel at: http://www.gnu.org/s/parallel/
301 You can install GNU Parallel in just 10 seconds with:
303     $ (wget -O - pi.dk/3 || lynx -source pi.dk/3 || curl pi.dk/3/ || \
304        fetch -o - http://pi.dk/3 ) > install.sh
305     $ sha1sum install.sh | grep 883c667e01eed62f975ad28b6d50e22a
306     12345678 883c667e 01eed62f 975ad28b 6d50e22a
307     $ md5sum install.sh | grep cc21b4c943fd03e93ae1ae49e28573c0
308     cc21b4c9 43fd03e9 3ae1ae49 e28573c0
309     $ sha512sum install.sh | grep ec113b49a54e705f86d51e784ebced224fdff3f52
310     79945d9d 250b42a4 2067bb00 99da012e c113b49a 54e705f8 6d51e784 ebced224
311     fdff3f52 ca588d64 e75f6033 61bd543f d631f592 2f87ceb2 ab034149 6df84a35
312     $ bash install.sh
314 Watch the intro video on http://www.youtube.com/playlist?list=PL284C9FF2488BC6D1
316 Walk through the tutorial (man parallel_tutorial). Your command line will love you for it.
318 When using programs that use GNU Parallel to process data for publication please cite:
320 O. Tange (2018): GNU Parallel 2018, March 2018, https://doi.org/10.5281/zenodo.1146014.
322 If you like GNU Parallel:
324 * Give a demo at your local user group/team/colleagues
325 * Post the intro videos on Reddit/Diaspora*/forums/blogs/ Identi.ca/Google+/Twitter/Facebook/Linkedin/mailing lists
326 * Get the merchandise https://gnuparallel.threadless.com/designs/gnu-parallel
327 * Request or write a review for your favourite blog or magazine
328 * Request or build a package for your favourite distribution (if it is not already there)
329 * Invite me for your next conference
331 If you use programs that use GNU Parallel for research:
333 * Please cite GNU Parallel in you publications (use --citation)
335 If GNU Parallel saves you money:
337 * (Have your company) donate to FSF https://my.fsf.org/donate/
340 = About GNU SQL =
342 GNU sql aims to give a simple, unified interface for accessing databases through all the different databases' command line clients. So far the focus has been on giving a common way to specify login information (protocol, username, password, hostname, and port number), size (database and table size), and running queries.
344 The database is addressed using a DBURL. If commands are left out you will get that database's interactive shell.
346 When using GNU SQL for a publication please cite:
348 O. Tange (2011): GNU SQL - A Command Line Tool for Accessing Different Databases Using DBURLs, ;login: The USENIX Magazine, April 2011:29-32.
351 = About GNU Niceload =
353 GNU niceload slows down a program when the computer load average (or other system activity) is above a certain limit. When the limit is reached the program will be suspended for some time. If the limit is a soft limit the program will be allowed to run for short amounts of time before being suspended again. If the limit is a hard limit the program will only be allowed to run when the system is below the limit.