add releasing patterns to docs

1 files changed, 81 insertions, 0 deletions

diff --git a/docs/onboarding.texi b/docs/onboarding.texi
index 7b9ccce..64fb0b1 100644
--- a/docs/onboarding.texi
+++ b/docs/onboarding.texi
@@ -206,3 +206,84 @@ $ taler-deployment-start
 @end example
 
 Now the symlink can be updated.
+
+@node releases
+@section releases
+
+
+@subsection Release Process and Checklists
+
+This document describes the process for releasing a new version of the various
+Taler components to the official GNU mirrors.
+
+The following components are published on the GNU mirrors
+
+@itemize
+@item taler-exchange (exchange.git)
+@item taler-merchant (merchant.git)
+@item talerfrontends (merchant-frontends.git)
+@item taler-bank (bank.git)
+@item taler-wallet-webex (wallet-webex.git)
+@end itemize
+
+@subsection Tagging
+
+Tag releases with an @b{annotated} commit, like
+
+@example
+git tag -a v0.1.0 -m "Official release v0.1.0"
+git push origin v0.1.0
+@end example
+
+@subsection Database for tests
+
+For tests in the exchange and merchant to run, make sure that
+a database @emph{talertest} is accessible by @emph{$USER}.  Otherwise tests
+involving the database logic are skipped.
+
+@subsection Exchange, merchant
+
+Set the version in @code{configure.ac}.  The commit being tagged
+should be the change of the version.
+
+For the exchange test cases to pass, @code{make install} must be run first.
+Without it, test cases will fail because plugins can't be located.
+
+
+@example
+./bootstrap
+./configure # add required options for your system
+make dist
+tar -xf taler-$COMPONENT-$VERSION.tar.gz
+cd taler-$COMPONENT-$VERSION
+make install check
+@end example
+
+
+@subsection Wallet WebExtension
+
+The version of the wallet is in @emph{manifest.json}.  The @code{version_name} should be
+adjusted, and @emph{version} should be increased independently on every upload to
+the WebStore.
+
+@example
+./configure
+make dist
+@end example
+
+@c FIXME: selenium test cases
+
+
+@subsection Upload to GNU mirrors
+
+See @emph{https://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads}
+
+Directive file: 
+
+@example
+version: 1.2
+directory: taler
+filename: taler-exchange-0.1.0.tar.gz
+@end example
+
+Upload the files in @b{binary mode} to the ftp servers.