Tails and its website are developed in numerous Git repositories.

Git is a distributed version control system. It allows several people to work on the same source code and handle changes in a distributed and efficient way.

Learn Git

To learn more about Git, refer to its homepage, and official documentation.

Here are a couple of links to get started with Git:

General information

Git hosting setup at immerda

Documentation for our Git hosting setup at immerda:

Merge policy

See our merge policy.

Caution!

If you intend to prepare Tails releases, you'll need to make the development team signing key the default one for Git tags:

git config user.signingkey A490D0F4D311A4153E2BB7CADBB802B258ACD84F

Repositories

Main repository

This repository contains the Tails source code and the source of the website.

Anyone can check it out like this:

git clone https://git-tails.immerda.ch/tails

Developers with write access to the repositories should instead:

git clone boum_org_amnesia@webmasters.boum.org:wiki.git

And then, in any case, in your new Git clone's directory:

git submodule update --init

For more information about our usage of Git submodules, see the dedicated section.

We have a web interface available for the main repository.

Configuration

Developers with write access to the repositories should:

git config --global url.tails@git.tails.boum.org:.insteadOf \
   https://git-tails.immerda.ch/

Branches

Tails development uses several branches modeled a bit like the Debian development process. Here they are.

master

The master branch is mostly used to build the website. It is merged into devel and stable from time to time. We merge into master:

stable

The stable branch is intended to contain:

  • the state of the code tagged for the last stable release
  • fixes for security or important bugs.

Its purpose is to prepare minor releases.

testing

The testing branch is used to prepare an imminent release: at some point of the development process, the devel branch code is merged into testing, frozen, and endures careful testing and bug-fixing until this branch is considered good enough to become a stable release. The testing branch is then merged into the stable and master ones, images built and shipped and we go back to code shiny new stuff in the devel branch.

Please note that the testing branch generally has not been granted the same testing and attention as code that has made it into a stable release: please use it for testing purposes but do not rely on it for anything. No guarantee, blablabla.

devel

Most of the development work that is done in Tails, is done in the devel branch. This branch will never get released; instead, code from it will be merged into testing and then into a real release.

Please note that the devel branch can be broken, have awful security problems and so on. No guarantee, blablabla.

The master branch is merged into devel from time to time.

Topic branches

We use topic branches called bugfix/* and feature/*, respectively aimed at fixing a single bug and implementing a single new feature. Once ready, a topic branch is merged (with --no-ff) into the appropriate branch (generally devel). Until it has been merged, a topic branch's history may be rewritten, e.g. it may be rebased on top of devel.

Unless there are good reasons to do otherwise, bugfix branches must be forked off the latest stable release tag, while feature branches should be forked off the devel branch.

If you intend to work on a branch not really meant to be proposed to a merge at first, like an experimenting branch that you still want to push to share with other developers, you can prefix its name by the keyword wip/. It will make it clear to everyone that this branch shouldn't be merged before being renamed, and our Jenkins instance will not build nor test it, so you won't get notifications for a branch that you know is breaking the build and/or the test suite.

Promotion material

This repository contains Tails promotion material.

Anyone can check it out like this:

git clone https://git-tails.immerda.ch/promotion-material

Developers with write access to the repositories should instead:

git clone boum_org_amnesia@webmasters.boum.org:promotion-material.git

We have a web interface available for the promotion material repository.

Puppet modules

Those who have SSH access to these repositories must configure their SSH client a bit, e.g.:

Host git.puppet.tails.boum.org
    HostName d53ykjpeekuikgoq.onion
    ProxyCommand torsocks monkeysphere ssh-proxycommand %h %p

tails

This is the main public Puppet module to manage Tails infrastructure, including classes such as tails::reprepro and tails::whisperback::relay.

Anyone can check it out like this:

git clone git://git.puppet.tails.boum.org/puppet-tails

Developers with write access to the repositories should instead:

git clone gitolite@git.puppet.tails.boum.org:puppet-tails

Other Puppet modules

We use and publish a lot of other Puppet modules. See the section about our other repositories.

tails_lizard_manifests

Developers with access to the APT secrets can check it out like this:

git clone gitolite@git.puppet.tails.boum.org:puppet-lizard-manifests

tails_secrets_apt

Developers with access to the APT secrets can check it out like this:

git clone gitolite@git.puppet.tails.boum.org:puppet-tails_secrets_apt

tails_secrets_whisperback

Developers with access to the WhisperBack secrets can check it out like this:

git clone gitolite@git.puppet.tails.boum.org:puppet-tails_secrets_whisperback

Other repositories

All other public Tails Git repositories are at https://git-tails.immerda.ch/.

Unauthenticated access is of the form:

git clone https://git-tails.immerda.ch/$REPOSITORY

Developers with write access to the repositories should instead:

git clone tails@git.tails.boum.org:$REPOSITORY

Submodules

We use Git submodules to track external repositories from the main Tails source tree.

The main practical consequence thereof so far, for most Tails contributors, is that one should generally run the following command after checking out a branch:

git submodule update --init

For more information, see:

Creating a new repository

In the vast majority of cases, your new repository will be hosted at https://git-tails.immerda.ch/. Here is how to get it created.

  1. Send your OpenPGP public key, pasted in the body of an email, to the Tails system administrators. State that you want to establish a communication channel in order to eventually get a Git repository created. Do not attach your public key, this would not work due to bugs in the mailing list software we use.
  2. Wait for the Tails system administrators to confirm they have received your OpenPGP public key and imported it into the keyring of their mailing list.
  3. Send your Git repository request in an OpenPGP-signed email to the Tails system administrators; include the following information:
    • the name you want to publicly use in our Git repository hosting system (only lower-case ASCII chars and digits);
    • the preferred name of the repository you want to create (only lower-case ASCII chars and digits);
    • your SSH RSA public key;
    • whether the repository shall be publicly available or not;
    • who else needs read access to the repository, plus their SSH RSA public key;
    • who else needs write access to the repository, plus their SSH RSA public key.

Once your repository has been created, clone it:

Initializing a git-remote-gcrypt repository

Clone the new, empty repository in a way that tells Git it's going to be encrypted:

git clone gcrypt::tails@git-tails.immerda.ch:$REPOSITORY

Change directory into the newly cloned repository:

cd $REPOSITORY

Decide whether you want to hide to the immerda administrators which OpenPGP keys this repository will be encrypted for (note that this has severe usability drawbacks). Skip to the next step if you really want that. Otherwise:

git config gcrypt.publish-participants true

Tell Git which OpenPGP keys the repository will be encrypted for:

git config gcrypt.participants "LIST OF OPENPGP FINGERPRINTS"

Write some setup instructions for your team-mates, e.g. copy and paste the git config command(s) you have just run:

editor README

Add these setup instructions to the repository and commit:

git add README && git commit -m 'Add setup documentation.'

Push:

git push -u origin master

Troubleshooting

First, check with your team-mates: in some cases they can help you troubleshoot your problem, and confirm whether the problem is on your side or on the server side. If that is not enough, read on.

  • For repositories hosted at git-tails.immerda.ch (aka. git.tails.boum.org) or at git.puppet.tails.boum.org: get in touch with Tails system administrators.

  • For repositories hosted at webmasters.boum.org: get in touch with root@boum.org.