Differences between revisions 67 and 68
Revision 67 as of 2018-03-13 16:09:16
Size: 15755
Editor: TheAnarcat
Comment: update notice, now that content is deduped
Revision 68 as of 2018-03-13 16:19:54
Size: 4477
Editor: TheAnarcat
Comment: move alioth migration in Salsa/AliothMigration because the page is too long
Deletions are marked like this. Additions are marked like this.
Line 84: Line 84:

= Hints for previous users of Alioth =

''Salsa'' provides services which partially replace some features of the former [[Alioth]] service. The following hints may help you to move your packaging collaboration effort from ''Alioth'' to ''Salsa''.

Many [[Alioth]] features are (intentionally) not provided by the ''Salsa'' platform. You may want to take a look at the [[Sprints/2017/Alioth/MeetingMinutes|related discussion during a sprint]] for the detailed reasons for this decision.

{{{#!wiki important
There is potential overlap between this section and the [[Alioth#Deprecation_of_Alioth]] documentation. Be careful to avoid adding documentation here that's already there and vice versa. Add links instead, as is already done. -- TheAnarcat <<DateTime(2018-03-13T16:09:16Z)>>

== Canonical Repository URLs ==

The canonical URLs for use in `debian/control` are:
Vcs-Browser: https://salsa.debian.org/<user-or-team>/<package>
Vcs-Git: https://salsa.debian.org/<user-or-team>/<package>.git
where `<user-or-team>` is
 * '''alice''' for DD Alice Developer <alice@debian.org>
 * '''bob-guest''' for non-DD Bob Coder <bobc@example.com>
 * '''debian''' for the Debian/ namespace (the equivalent to collab-maint on alioth)
 * '''foobar-team''' for the Foobar Packaging Team

You can instruct git to rewrite URLs into pushable ssh URLs:
git config --global url."git@salsa.debian.org:".pushInsteadOf "https://salsa.debian.org/"
This will work for all salsa repositories checked out via https:// URLs in the present, past or future.

You can also use a shortcut for all Salsa repositories:

git config --global url."git@salsa.debian.org:".insteadOf salsa:

This way you can use a shorter commandline like this:

git clone salsa:debian/htop

== Custom Hooks ==

For security reasons it is not allowed to run arbitrary custom hooks
on repositories. You may want to write yourself a webhook receiver and
put your custom actions into such a one.

Alternatively you may use the common webhook receiver or even enhance
it with new features, see https://salsa.debian.org/salsa/webhook for
details on it.

== Import git repository ==

This is currently done by hand but Christoph Berg's wrote a handy [[http://www.df7cb.de/blog/2017/Salsa_batch_import.html|batch import script]] that you can use to import your projects semi-automatically.

Once a repository is migrated, you may want to archive the repository on Alioth. One way to do this is to add a pre-receive hook that exits with a non-zero status code, for example:

$ cat /git/collab-maint/magic-wormhole.git/hooks/pre-receive

cat <<EOF
Repository was moved to Salsa.


Push refused, this repository was archived. Update your remotes to use the following URL instead:


exit 1

Make sure the file is executable (`chmod +x`) and also update the description similarly so the web interface shows the change as well. You can do this automatically with `~hertzog/bin/disable-repository <path-to-git-repo> <name-of-salsa-group>`.

You may also want to add an HTTP redirect from the old repository on Alioth to the new one on Salsa (`git://` and `git+ssh://` cannot be redirected, so you should still make sure to add the pre-receive hook above). You can do this by sending a merge request for [[https://salsa.debian.org/salsa/AliothRewriter|AliothRewriter]].

To find repositories to migrate, you might like the following `find` commandline:

$ find ~/src -ipath '*.git/config' -exec grep -H 'url.*git\.debian' '{}' \;

replace `~/src` by the path where you usually store your git repositories.

== Import non-git version control repository ==
Only git repositories are supported by the ''Salsa'' platform.

You may want to take a look at the [[Sprints/2017/Alioth/MeetingMinutes/VCS|reasons for not supporting other version control systems]] within ''Salsa''.

== Import mailing list ==

''Salsa'' does not offer any mailing list features on its own (see [[Sprints/2017/Alioth/MeetingMinutes/Mailinglists|discussion]]). There are three options to replace the mailing list:

 1. migrate to lists.debian.org
 2. stay on lists.alioth.debian.org
 3. migrate to tracker.debian.org
 4. use gitlab notifications

See below for details.

=== lists.alioth.debian.org ===

A team is attempting to migrate lists previously on alioth to a new service retaining the same name @lists.alioth.debian.org; see [[Alioth/MailingListContinuation]] and [[https://lists.debian.org/debian-devel-announce/2018/01/msg00003.html|the announcement]].

=== lists.debian.org ===

Some mailing lists that were formerly hosted on Alioth may be eligible for being hosted on [[https://lists.debian.org|lists.debian.org]]. The lists eligible for migration must follow the requirements outlined on the [[https://www.debian.org/MailingLists/HOWTO_start_list|"How to ask a mailing list" guide]]. The process is also the same as outlined on the guide.

The following kind of lists are probably acceptable for [[https://lists.debian.org|lists.debian.org]]:
 * The list is expected to be useful, to have a purpose and an audience.
 * Public discussion or support lists are probably OK.
 * Commit or bug notifications lists are not OK. You should use the dedicated features of gitlab instead. If you're interested in a package's bug, you're expected to subscribe to it using the [[http://bugs.debian.org/|BTS]] features.

Short version: file a bug on the [[https://bugs.debian.org/lists.debian.org|pseudo-package lists.debian.org]] with the severity 'wishlist', with the following information:
 * List Name
 * Rationale (why do you need this list, stating that you had one on Alioth is not enough!)
 * Short Description (for display in list indices)
 * Long Description (targeted to people that need to decide if they want to join)
 * Category

Lists migrated from Alioth are expected to be open, that is:
 * Open Subscription Policy (no closed lists)
 * Open Post Policy (anybody can post)
 * Open Archive
 * No moderation

If you do want the archive and/or the subscribers to be imported into your new mailing list, please:
 * on alioth, using your ssh access, run 'sudo /usr/local/bin/export-list <mailing_list_name>' to get gzipped tar archive (on stdout) containing:
  * mbox file of the archive
  * subscribers list in simple text file
 * import the resulting mbox file in your favorite e-mail reader and clean the spam,
 * attach the compressed archive and/or the list of subscribers to your request.

The export only works if the 'Is archive file source for public or private archival?' archive setting is true.

Before any migration ensure that there is consensus about the migration and that you have permission from the subscribers. For privacy reasons we expect that the migration process is
done by an admin of the list or the alioth project.

Also, please understand that the requirements and features for lists on lists.debian.org are not the same as for a mailing list on Alioth, and the listmaster might reject your request. Lists.debian.org is not supposed to replace all mailing lists and aliases on Alioth.

=== tracker.debian.org ===

Smaller teams can use the mail interface of tracker.debian.org to register to package changes and reach out to other maintainers in a team. For example, commit notifications for third-party repositories can use the `dispatch+<package>_vcs@tracker.debian.org` email address to send notifications to maintainers. For the maintainer field, the `<package>@packages.debian.org` address should be used (although that needs the fix for DebianBug:871575 to be deployed on ftp-master, see [[https://lists.debian.org/debian-devel/2017/09/msg00272.html|this discussion for details]].

==== Clarification Request / Open Questions ====

 * Can e-mail addresses of the form <package>@tracker.debian.org be used as maintainer team address in Maintainer or Uploader fields of package? No. But you can use team+foo@tracker.debian.org if you have created the "foo" team on https://tracker.debian.org/teams/ (or you can use <sourcepackage>@packages.debian.org for single packages which are not team maintained).
 * Are there archives of mails to these addresses? not that we know of.

=== gitlab notifications ===

In Gitlab, anyone can subscribe to different notifications for changes in a repository. This can replace the traditionnal `-commit` mailing lists that are on alioth, hopefully.

== Import members of a team ==
It is not possible to transfer the members of an Alioth team to ''Salsa''. You will need to ask the members of your team to join your team on ''Salsa'' individually.

== Host project web pages ==
Gitlab offer the "Gitlab Pages" feature, and it is enabled on Salsa as '''`https://<namespace>.pages.debian.net/<project>`'''

This feature makes use of Gitlab-CI to generate static pages in a `public` directory, on every push.

See https://docs.gitlab.com/ce/user/project/pages/index.html for a detailed documentation and HOWTOs.

 * '''''Note:''' there is no SSL for <namespace>.pages.debian.net, since Let's Encrypt doesn't provide wildcard certificates yet. But this should be fixed in [[https://letsencrypt.org/2017/07/06/wildcard-certificates-coming-jan-2018.html|2018]].''

=== Quick start ===

 1. On your project Home, use '''`Set up CI`''' button
 1. Choose a '''`Gitlab CI Yaml template`''' ('''`Pages`''' templates are at the end)
 1. Edit the template to suit your needs and save it
 1. Push something to the repository. You will see there is a CI Job pending
 1. Wait a few minutes for the job to run. When it's '''`Passed`''' you can see your pages at https://<namespace>.pages.debian.net/<project>/)

  * '''''Note:''' Even though we plan to support simple page generators like Jekyll or Hugo in the future, in most cases, you should content yourself with the `HTML` template, and generate the pages locally to push them afterward, in order to save the resources on the runner. Some templates might require commands not available on the server anyway.''
  * '''''Note 2: We mean that. Really.''' Be nice to the server. At some point in the future we hope to add some dedicated Runners servers - Sponsors welcome! ;).''

== Share a group with all Debian developers ==

On Alioth, some repositories were configured in such a way that all Debian developers had automatically write access regardless of their membership to the corresponding Alioth team. It is possible to do the same on Salsa by sharing a project with the Debian group, which contains all debian developers as members.

To achieve that, go to the page of the project, and under Settings -> Members, there is a tab "Share with group". Select the group Debian.

Note that doing so will clutter the list of groups of all Debian developers (see
https://gitlab.com/gitlab-org/gitlab-ce/issues/43397). Also this operation is not so easy to script compared to the rest (see https://lists.debian.org/debian-perl/2018/01/msg00045.html and https://salsa.debian.org/mehdi/salsa-scripts/issues/5).

Salsa Documentation

Salsa is a collaborative development platform within Debian.


To get support join us at #alioth@oftc or create an issue in our support tracker.

Users: Login and Registration

  • Debian Developers can login with their Debian email address

    • you need to use your official Debian email address in order to gain specific permissions for Debian Developers
    • Use password recovery on https://salsa.debian.org/users/sign_in to get a password for your account. Please don't use your Debian password. Salsa has its own password database.

  • everyone else can register an account with an implicitly added suffix -guest. There is a a self service webfrontend for doing so at https://signup.salsa.debian.org/

Namespace concepts (Users, Teams)

Debian Developers

Debian Developers get synced every 6 hours from LDAP and retain their Debian login as salsa username.

External Users

To avoid clash with the Debian LDAP Usernames, external users get a suffix of -guest to their username.


Users and Group share the same namespace. To prevent clashes with usernames we enforce groups to a '-team' suffix, with the exception being the 'Debian' group, of which all Debian Developers are members.

To create a group, log in and go to the team registration page. There is also a link to it from the registration page: if you're not logged in yet, you will be asked to do so and be redirected afterwards.

Projects and Repositories

A project = a repository.

You can create several projects in the same namespace (user or group).

Debian Developers are able to create projects in the Debian/ Namespace. It's the Salsa equivalent of 'collab-maint' on Alioth, and non-DDs (DMs or external contributors) need to be explicitly granted commit privileges for single projects.

Email notifications

Every project owner can enable "email on push". To do so, go the project settings → integrations → project services → email on push and configure the list of recipients you want to send emails to.

In particular, to forward emails to tracker.debian.org, you should add dispatch@tracker.debian.org to the recipients (or, if for some not good reason the project name is not the name of the source package, dispatch+${package}_vcs@tracker.debian.org (where ${package} is the source package name)).

IRC notifications


Alexander Wirt is sponsoring an Irker instance. It can be enabled with the irker integration available under Settings/Integrations/Irker. Please use the following settings:

Under recipients add a newline separated list of recipients/channels. If your channel is protected by a key, use the syntax channel-name?key=whatever omitting the leading # sign (failing to omit the # sign will result in Irker joining a channel literally named #channel-name?key=whatever and doing so making your channel key public as it is visible in the bot's /whois.
Currently only Push events are supported.


KGB supports gitlab webhooks. To use the kgb instances provided by dam, tincho, and gregoa from salsa, set a webhook in your project:


For details, additional parameters, and helper scripts see the KGB documentation at https://salsa.debian.org/kgb-team/kgb/wikis/usage

Dealing with Debian BTS from commit messages

We run a webhook receiver that can modify the Debian BTS based on commit messages. If you want to use it, go to your project, "Settings -> integrations" and add a URL (see below), then click save. No secret token is needed, and currently it only deals with push events.

Possible URLs:


Replace SOURCENAME with the name of your source package and chose either close or tag pending, depending on the action you want to get.

See the code for more details: https://salsa.debian.org/salsa/webhook.

Getting Help

See the Salsa maintenance description.