svnpublish 2.0.4

Enables powerful automation from a subversion repository.

Welcome to svnpublish, a tool to enable automated publishing (and any other arbitrary commands to be executed) when updates are made to a subversion version control repository.

Publishing configurations are tied to either the entire repository or restricted to subdirectories, referred to as a publishing point in svnpublish-speak.

Warning

For installation, use easy_install, not pip! The latter is currently breaking pkg_resources’ ability to load resources.

Project

• Homepage: https://github.com/metagriffin/svnpublish

• Bugs: https://github.com/metagriffin/svnpublish/issues

TL;DR

Install:

$ easy_install svnpublish
$ mkdir -p /etc/svnpublish
$ svnpublish --init-options > /etc/svnpublish/myrepos.yaml

# edit the configuration file
$ vi /etc/svnpublish/myrepos.yaml

Put in your REPOSITORY/hooks/post-commit:

#!/bin/sh
svnpublish --options /etc/svnpublish/myrepos.yaml "$@"

If running in asynchronous mode:

TODO: show example of getting svnpublishd running

Overview

TODO: add docs

Global Configuration

The best way to set the initial svnpublish options is to use the --init-options flag, which outputs a list of all available options accompanied with documentation. The recommended approach is to create a per-repository configuration in /etc/svnpublish/ which can be done as follows:

$ sudo mkdir -p /etc/svnpublish
$ svnpublish --init-options | sudo tee /etc/svnpublish/REPOSITORY.yaml > /dev/null
$ sudo vi /etc/svnpublish/REPOSITORY.yaml

And then modifying all of the options as needed. At a minimum, the following options should be set:

• admin

• label

• name

• reposUrl

• genemail.default.headers.from

Publishing Point Configuration

TODO: add docs

publish:

  ENGINE:

    ATTRIBUTE: VALUE

Example:

publish:

  # send an email notification
  - engine:       email
    mailfrom:     [e-mail]
    recipients:
                  - [e-mail]
                  - [e-mail]

  # update an RSS (atom) feed
  - engine:       rss
    window:       50
    label:        Repository Feed
    output:       /var/www/rss/output.xml
    feedUrl:      https://svn.example.com/rss/output.xml

  # export the repository to the file system
  - engine:       export
    path:         /var/www/example.com
    fixate:
                  - { engine: fingerprint }
                  - { engine: fingerprint, path: htdocs/fingerprint }

  # export the repository to a remote host
  - engine:       export
    remote:       [e-mail]
    keychain:     /home/svnpublish/.keychain
    path:         /var/www/example.com
    fixate:
                  - { engine: fingerprint }
                  - { engine: fingerprint, path: htdocs/fingerprint }

Encrypted Email

SvnPublish can be configured to send PGP-encrypted email, which protects the contents of the emails from being read by unintended recipients. This is accomplished by using genemail’s “Modifier” facility and using GPG to do the actual encryption. Steps to get it setup:

1. First, setup the svnpublish account with a GPG home directory. For example:

# create the directory
$ mkdir -p /path/to/gpghome
$ chmod 700 /path/to/gpghome

# for signing, svnpublish needs a private key. generate one:
$ gpg --homedir /path/to/gpghome --gen-key

# for encryption, svnpublish needs the public key of every
# recipient of encrypted emails:
$ gpg --homedir /path/to/gpghome --import /path/to/public.key

2. Then, configure genemail (in your svnpublish “options.yaml” file) to use the svnpublish.email.EncryptModifier. For example:

# ... other configurations ...

genemail:
  modifier:
    class:   'svnpublish.email.EncryptModifier'
    sign:    '[e-mail]'
    prune:   true
    gpg_options:
      gnupghome: '/path/to/gpghome'
      use_agent: false

(See svnpublish --init-options for details on the various options available.)