10872
Comment:
|
11922
update gitlab-ci example files
|
Deletions are marked like this. | Additions are marked like this. |
Line 120: | Line 120: |
See the code for more details: https://salsa.debian.org/salsa/webhook. | You can ignore a branch or pattern, say wip/*, by providing the ignored-namespaces parameter. See the README in code for more details. Code: https://salsa.debian.org/salsa/webhook. |
Line 150: | Line 153: |
3. For an automated ''git-buildpackage'' setup, use the [[https://gitlab.com/eighthave/ci-image-git-buildpackage|ci-image-git-buildpackage]] Docker image that is in development, for example: | 3. For an automated ''git-buildpackage'' setup, use the [[https://salsa.debian.org/salsa-ci-team/ci-image-git-buildpackage|ci-image-git-buildpackage]] Docker image that is in development. For example, for a standard ''git-buildpackage'' run with ''lintian'', then ''autopkgtest'': |
Line 161: | Line 164: |
- cp ../*.deb . # copy it into place to be saved as an artifact - autopkgtest ../*.changes -- null }}} |
- gitlab-ci-git-buildpackage-all }}} If you want the build result to be posted to an apt repo, then use the ''aptly'' script. It'll be posted to an unsigned repo on pages.debian.net. For example, https://salsa.debian.org/foo/bar will be posted to https://foo.pages.debian.net/bar. {{{#!highlight yaml image: registry.gitlab.com/eighthave/ci-image-git-buildpackage:latest pages: stage: deploy artifacts: paths: - public script: - gitlab-ci-git-buildpackage-all - gitlab-ci-aptly }}} It is also possible to run each step manually or even split them into separate GitLab CI "Jobs": {{{#!highlight yaml image: registry.gitlab.com/eighthave/ci-image-git-buildpackage:latest pages: stage: deploy artifacts: paths: - public script: - gitlab-ci-enable-experimental - gitlab-ci-git-buildpackage - gitlab-ci-lintian - gitlab-ci-autopkgtest - gitlab-ci-aptly }}} |
Contents
- Salsa Documentation
- Support
- Users: Login and Registration
- Namespace concepts (Users, Teams)
- Projects and Repositories
- Email notifications
- Information on manipulating bugs by email
- IRC notifications
- Dealing with Debian BTS from commit messages
- Deployment keys
- Runners
- Running Continuous Integration (CI) tests
- Web page hosting
- Getting Help
Salsa Documentation
Salsa is a collaborative development platform within Debian.
Support
To get support join us at #alioth@oftc, create an issue in our support tracker or send a mail to salsa-admin@debian.org.
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.
Groups
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.
The debian group is for CollaborativeMaintenance (the old collab-maint on Alioth). The group is accessible to all Debian developers by default, who are automatically added with master access levels.
External users need to request access to a Debian developer they know, or their sponsor. Access should be granted to single projects and not the whole Debian group.
Canonical 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
Projects and Repositories
In GitLab, a project is one Git repository, and each Git repository needs a project. You can create several projects in the same namespace (user or group).
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)).
Take into account that the current implementation sends a single mail per push with all commits lumped together, which makes it rather useless for any post-review workflow. This is tracked upstream at https://gitlab.com/gitlab-org/gitlab-ce/issues/19901.
Information on manipulating bugs by email
GitLab has quite a lot of text commands aka "quick actions" which can be used when interacting with GitLab via email. Most things can be done via email by replying to the email notifications. There are special email addresses for creating new merge requests and issues via email.
IRC notifications
Irker
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:
- Server host: ruprecht.snow-crash.org
- Server port: 6659
Default IRC URI: irc://irc.oftc.net:6667/
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
KGB supports gitlab webhooks. To use the kgb instances provided by dam, tincho, and gregoa from salsa, set a webhook in your project:
http://kgb.debian.net:9418/webhook/?channel=<irc-channel-name-without-#>
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:
https://webhook.salsa.debian.org/close/SOURCENAME https://webhook.salsa.debian.org/tagpending/SOURCENAME
Replace SOURCENAME with the name of your source package and chose either close or tag pending, depending on the action you want to get.
You can ignore a branch or pattern, say wip/*, by providing the ignored-namespaces parameter. See the README in code for more details.
Code: https://salsa.debian.org/salsa/webhook.
Deployment keys
For automating task FIXME
Runners
For information about the shared runners, refer to the original salsa announcement:
Bastian (waldi) and Alexander (formorer) added two shared runners, one running on the Google Platform, one on Azure to allow experiments with gitlab-ci. Both runners use docker to provide images. You can use every image available in the official docker registry. If you don't choose an image it defaults to debian:9. We are still looking for some offical sponsors of runners, please contact us at salsa-admin@debian.org if you want to sponsor one.
You may also add specific runners and configure them for your project, here is a list of the runners that are currently available:
Runner Name |
Maintainer |
Purpose |
chuchi |
stapelberg |
TODO |
Running Continuous Integration (CI) tests
Gitlab provides very flexible and full featured CI functionality built in. Using simple YAML files, the Gitlab CI setup will run the scripts in .gitlab-ci.yml in the specified Docker image, and report the results with a full log. This can also be used to build and deploy static websites using "Gitlab Pages", and more.
In your project's "CI/CD Settings" (e.g. https://salsa.debian.org/debian/fdroidserver/settings/ci_cd), set "Custom CI config path" to debian/.gitlab-ci.yml
Create debian/.gitlab-ci.yml and commit it to your project's master branch
For an automated git-buildpackage setup, use the ci-image-git-buildpackage Docker image that is in development. For example, for a standard git-buildpackage run with lintian, then autopkgtest:
If you want the build result to be posted to an apt repo, then use the aptly script. It'll be posted to an unsigned repo on pages.debian.net. For example, https://salsa.debian.org/foo/bar will be posted to https://foo.pages.debian.net/bar.
It is also possible to run each step manually or even split them into separate GitLab CI "Jobs":
There is a more basic setup based on building with dpkg-buildpackage as documented on the Gitlab blog: Automated Debian Package Build with GitLab CI
Web page hosting
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 the official documentation for a details.
https://<namespace>.pages.debian.net should work, thanks to Let's Encrypt new wildcard certificate support.
Quick start
On your project Home, use Set up CI/CD button. (If your project is empty, select New file instead.)
Choose a Gitlab CI Yaml template (Pages templates are at the end)
- Edit the template to suit your needs and save it
- Push something to the repository. You will see there is a CI Job pending
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>/)
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.
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!
important: (at least for static pages deployment) your artifacts must be stored in a directory named public/; if they are currently in a different location, use the script section in .gitlab-ci.yml to create that dir and copy the content there.
Getting Help
See the Salsa maintenance description.