SALSA(1)

📦
version 2.26.11ubuntu1 · 15 versions
, in ubuntu stonking

NAME

okay so bestie, this is SALSA(1) 💅 — salsa is your tool to manipulate salsa projects, repositories, and group members. periodt. 🫶

SYNOPSIS

Here's the vibe of how you call it:

# salsa <command> <parameters> <options>
salsa add_user developer foobar --group-id 2665
salsa delete_user foobar --group js-team
salsa search_groups perl-team/modules
salsa search_projects qa/qa
salsa search_users yadd
salsa update_user maintainer foobar --group js-team
salsa whoami
salsa checkout node-mongodb --group js-team
salsa fork --group js-team user/node-foo
salsa last_ci_status js-team/nodejs
salsa pipelines js-team/nodejs
salsa mr debian/foo debian/latest
salsa push_repo . --group js-team --kgb --irc devscripts --tagpending
salsa update_projects node-mongodb --group js-team --disable-kgb --desc \
      --desc-pattern "Package %p"
salsa update_safe --all --desc --desc-pattern "Debian package %p" \
      --group js-team
salsa update_watch5 debian/devscripts
salsa update_watch5 --group js-team --all

DESCRIPTION

okay so salsa is designed to create and configure projects and repositories on <https://salsa.debian.org> as well as to manage group members. no biggie. 💖

A Salsa token is required, except for search* commands, and must be set in command line (see below), or in your configuration file (~/.devscripts):

SALSA_TOKEN=abcdefghi

or

SALSA_TOKEN=`cat ~/.token`

or

SALSA_TOKEN_FILE=~/.dpt.conf

If you choose to link another file using SALSA_TOKEN_FILE, it must contain a line with one of (no differences):

<anything>SALSA_PRIVATE_TOKEN=xxxx
<anything>SALSA_TOKEN=xxxx

This allows for example to use dpt(1) configuration file (~/.dpt.conf) which contains:

DPT_SALSA_PRIVATE_TOKEN=abcdefghi

COMMANDS

Managing users and groups

add_user

Add a user to a group. 💖

salsa --group js-group add_user guest foouser
salsa --group-id 1234 add_user guest foouser
salsa --group-id 1234 add_user maintainer 1245

First argument is the GitLab's access levels: guest, reporter, developer, maintainer, owner. slay.

delete_user or del_user

Remove a user from a group. bye boo! 👋

salsa --group js-team delete_user foouser
salsa --group-id=1234 delete_user foouser

join

Request access to a group. like sliding into their DMs but for permissions 💅

salsa join js-team
salsa join --group js-team
salsa join --group-id 1234

list_groups

List the subgroups for current group if group is set, otherwise will do the current user. no examples, just vibes. ✨

list_users or group

List users in a subgroup. Note, this does not include inherited or invited. 🙈

salsa --group js-team list_users
salsa --group-id 1234 list_users

search_groups

Search for a group using given string. Shows group ID and other information. 🔍

salsa search_groups perl-team
salsa search_groups perl-team/modules
salsa search_groups 2666

search_users

Search for a user using given string. Shows user ID and other information. 🕵️‍♀️

salsa search_users yadd

update_user

Update a user's role in a group. glow up! ✨

salsa --group-id 1234 update_user guest foouser
salsa --group js-team update_user maintainer 1245

First argument is the GitLab's access levels: guest, reporter, developer, maintainer, owner. periodt.

whoami

Gives information on the token owner. main character energy. 👑

salsa whoami

Managing projects

One of --group, --group-id, --user or --user-id is required to manage projects. If both are set, salsa warns and only --user/--user-id is used. If none is given, salsa uses current user ID (token owner). lowkey important. 💅

check_projects or check_repo

Verify that projects are configured as expected. It works exactly like update_projects except that it does not modify anything but just lists projects not well configured with found errors. 🕵️‍♀️

salsa --user yadd --tagpending --kgb --irc=devscripts check_projects test
salsa --group js-team check_projects --all
salsa --group js-team --rename-head check_projects test1 test2 test3

checkout or co

Clone a project's repository in current directory. If the directory already exists, update local repository. it's giving git clone but make it salsa. 💖

salsa --user yadd checkout devscripts
salsa --group js-team checkout node-mongodb
salsa checkout js-team/node-mongodb
salsa checkout https://salsa.debian.org/debian/devscripts.git

You can clone more than one repository or all repositories of a group or a user:

salsa --user yadd checkout devscripts autodep8
salsa checkout yadd/devscripts js-team/npm
salsa --group js-team checkout --all           # All js-team active repositories
salsa checkout --all-archived                  # All your repositories, including archived

create_project or create_repo

Create public empty project. If --group/--group-id is set, project is created in group directory, else in user directory. ✨

salsa --user yadd create_project test
salsa --group js-team --kgb --irc-channel=devscripts create_project test

delete_project or del_repo

Delete a project. poof, gone. 💀

fork

Forks a project in group/user repository and set "upstream" to original project. Example:

$ salsa fork js-team/node-mongodb --verbose
...
salsa.pl info: node-mongodb ready in node-mongodb/
$ cd node-mongodb
$ git remote --verbose show
origin          git@salsa.debian.org:me/node-mongodb (fetch)
origin          git@salsa.debian.org:me/node-mongodb (push)
upstream        git@salsa.debian.org:js-team/node-mongodb (fetch)
upstream        git@salsa.debian.org:js-team/node-mongodb (push)

For a group:

salsa fork --group js-team user/node-foo

forks

List forks of project(s). 👯‍♀️

salsa forks qa/qa debian/devscripts

Project can be set using full path or using --group/--group-id or --user/--user-id, else it is searched in current user namespace.

push

Push relevant packaging refs to origin Git remote. To be run from packaging working directory. 🚀

salsa push

It pushes the following refs to the configured remote for the debian-branch or, falling back, to the "origin" remote:

  • "master" branch (or whatever is set to debian-branch in gbp.conf)
  • "upstream" branch (or whatever is set to upstream-branch in gbp.conf)
  • "pristine-tar" branch
  • tags named "debian/*" (or whatever is set to debian-tag in gbp.conf)
  • tags named "upstream/*" (or whatever is set to upstream-tag in gbp.conf)
  • all tags, if the package's source format is "3.0 (native)"

list_projects or list_repos or ls

Shows projects owned by user or group. If second argument exists, search only matching projects. 📋

salsa --group js-team list_projects
salsa --user yadd list_projects foo*

last_ci_status

Displays the last continuous integration result. Use --verbose to see URL of pipeline when result isn't success. Unless --no-fail is set, salsa last_ci_status will stop on first "failed" status. 😭

salsa --group js-team last_ci_status --all --no-fail
salsa --user yadd last_ci_status foo
salsa last_ci_status js-team/nodejs

This commands returns the number of "failed" status found. "success" entries are displayed using STDOUT while other are displayed (with details) using STDERR. Then you can easily see only failures using:

salsa --group js-team last_ci_status --all --no-fail >/dev/null

pipeline_schedule or schedule

Control pipeline schedule. ⏰

pipeline_schedules or schedules

Lists current pipeline schedule items. 🗓️

You can use --no-fail and --all options here.

merge_request or mr

Creates a merge request. ✨

Suppose you created a fork using salsa fork, modify some things in a new branch using one commit and want to propose it to original project (branch "master"). You just have to launch this in source directory:

salsa merge_request

Another example:

salsa merge_request --mr-dst-project debian/foo --mr-dst-branch debian/latest

Or simply:

salsa merge_request debian/foo debian/latest

Note that unless destination project has been set using command line, salsa merge_request will search it in the following order:

  • using GitLab API: salsa will detect from where this project was forked
  • using "upstream" origin
  • else salsa will use source project as destination project

To force salsa to use source project as destination project, you can use "same":

salsa merge_request --mr-dst-project same
# or
salsa merge_request same

New merge request will be created using last commit title and description.

See --mr-* options for more.

merge_requests or mrs

List opened merge requests for project(s). 📬

salsa merge_requests qa/qa debian/devscripts

Project can be set using full path or using --group/--group-id or --user/--user-id, else it is searched in current user namespace.

protect_branch

Protect/unprotect a branch. 🛡️

Protect

#                                    project      branch merge push
salsa --group js-team protect_branch node-mongodb master m     d

"merge" and "push" can be one of:

  • o, owner: owner only
  • m, maintainer: o + maintainers allowed
  • d, developer: m + developers allowed
  • r, reporter: d + reporters allowed
  • g, guest: r + guest allowed

Unprotect

salsa --group js-team protect_branch node-mongodb master no

protected_branches

List protected branches: 🔒

salsa --group js-team protected_branches node-mongodb

push_repo

Create a new project from a local Debian source directory configured with git. 🚀

push_repo executes the following steps:

  • gets project name using debian/changelog file;
  • launches git remote add upstream ...;
  • launches create_project;
  • pushes local repository.

Examples:

salsa --user yadd push_repo ./test
salsa --group js-team --kgb --irc-channel=devscripts push_repo .

rename_branch

Rename branch given in --source-branch with name given in --dest-branch. You can use --no-fail, --all and --all-archived options here. 🏷️

  • rename_branches — renames a whole lil squad of branches at once inside one project. 💅 First argument is the project name, then comes the branch mappings. The default branch gets detected automatically and updated if you renamed it too. iykyk
salsa rename_branches my-project master:debian/latest debian/master:debian/unstable

You can flex with --no-wait if you don't wanna sit around waiting for the changes to show up on the server, and --no-fail to keep going even if a branch rename straight-up fails. no cap

salsa rename_branches --no-wait --no-fail my-project master:debian/latest

And there's --dep14 for using DEP-14 default branch mappings. obsessed

salsa rename_branches --dep14 my-project
  • file — this one's the project-file glow-up station, it manipulates repository files on Salsa. 🎀
salsa file <get|create|edit|delete|create_or_edit> <project_name> <file_path> [options]
  • get — retrieves the content of a file from a repository. literally just handing it to you
salsa file get my-project README.md --ref my-branch
  • create — creates a brand new file in a repository. main character debut ✨
salsa file create my-project README.md --content-from-file path/to/README.md --branch my-branch --commit-message "Add README"
  • edit — edits a file that already exists in a repository. glow up time
salsa file edit my-project README.md --content-from-file path/to/README.md --branch my-branch --commit-message "Update README"
  • delete — deletes a file from a repository. rip bestie 💀
salsa file delete my-project README.md --branch my-branch --commit-message "Remove README"
  • create_or_edit — the indecisive icon: creates a new file or edits an existing one, whichever applies. 🦋
salsa file create_or_edit my-project README.md --content-from-file path/to/README.md --branch my-branch --commit-message "Update README"
  • search_projects or search_repo or search — search for a project using the given string. It shows you the name, owner ID and other info. three names, one queen 👑
salsa search_projects devscripts
salsa search_projects debian/devscripts
salsa search_projects 18475
  • update_projects or update_repo — configures projects using the parameters you hand it on the command line. You gotta give a project name unless --all or --all-archived is set. (And fr, prefer using update_safe.)
salsa --user yadd --tagpending --kgb --irc=devscripts update_projects test
salsa --group js-team update_projects --all
salsa --group js-team --rename-head update_projects test1 test2 test3
salsa update_projects js-team/node-mongodb --kgb --irc debian-js

By default, when you're using --all, salsa will fail on the first error. If you'd rather keep going, set --no-fail. When you do that, salsa will display a warning for each project that failed but keep going to the next project. Then, if you wanna see the full errors, set --verbose.

  • update_safe — launches check_projects and asks before launching update_projects (unless --yes). the cautious queen we stan 🌸
salsa --user yadd --tagpending --kgb --irc=devscripts update_safe test
salsa --group js-team update_safe --all
salsa --group js-team --rename-head update_safe test1 test2 test3
salsa update_safe js-team/node-mongodb --kgb --irc debian-js
  • update_watch5 — updates the "debian/watch" file for each given project to version 5.

Options --all and --debian-branch are usable here. 👑

  • update_gbp_conf — updates debian/gbp.conf with the branches discovered on the server. First argument is the project name.
salsa update_gbp_conf my-project
  • path — a lil baby subcommand to get the salsa path from a local git repo:
salsa path
salsa path ./directory

🫶 Other 🫶

  • purge_cache — empties the local cache. bye bye cached data 💖

✨ OPTIONS ✨

💖 General options 💖

  • --chdir, -C — change directory before launching the command. it's giving "go there first" 🚶‍♀️
salsa --chdir ~/debian checkout debian/libapache2-mod-fcgid
  • --cache-file — file to store cached values in. An empty value disables the cache. Default: "~/.cache/salsa.json".

.devscripts value: SALSA_CACHE_FILE

  • --no-cache — disable cache usage. Same as --cache-file ''. periodt
  • --conf-file, --conffile — add or replace default configuration files. This can only be used as the first option given on the command-line. Default: "/etc/devscripts.conf" and "~/.devscripts".

replace:

salsa --conf-file test.conf <command>...
salsa --conf-file test.conf --conf-file test2.conf  <command>...

add:

salsa --conf-file +test.conf <command>...
salsa --conf-file +test.conf --conf-file +test2.conf  <command>...
If one --conf-file has no "+", default configuration files are ignored. 🙈
  • --no-conf, --noconf — don't read any configuration files. This can only be used as the first option given on the command-line.
  • --debug — enable debugging output. we love receipts 🔍
  • --group — team to use. Use "salsa search_groups name" to find it.

If you wanna use a subgroup, you have to set its full path:

salsa --group perl-team/modules/packages check_projects lemonldap-ng

.devscripts value: SALSA_GROUP

Be careful when you use SALSA_GROUP in your ".devscripts" file. Every salsa command will be executed in group space. For example, if you want to propose a little change in a project using salsa fork + salsa merge_request, this "fork" will be done in group space unless you set a --user/--user-id. Prefer to use an alias in your ".bashrc" file. Example: 😭
alias jsteam_admin="salsa --group js-team"

or

alias jsteam_admin="salsa --conf-file ~/.js.conf

or to use both .devscripts and .js.conf:

alias jsteam_admin="salsa --conf-file +~/.js.conf

then you can fix SALSA_GROUP in "~/.js.conf"

To enable bash completion for your alias, add this in your .bashrc file:

_completion_loader salsa
complete -F _salsa_completion jsteam_admin
  • --group-id — group ID to use. Use "salsa search_groups name" to find it.

.devscripts value: SALSA_GROUP_ID

Be careful when you use SALSA_GROUP_ID in your ".devscripts" file. Every salsa command will be executed in group space. For example, if you want to propose a little change in a project using salsa fork + salsa merge_request, this "fork" will be done in group space unless you set a --user/--user-id. Prefer to use an alias in your ".bashrc" file. Example: 😭
alias jsteam_admin="salsa --group-id 2666"

or

alias jsteam_admin="salsa --conf-file ~/.js.conf

then you can fix SALSA_GROUP_ID in "~/.js.conf".

  • --help — displays this manpage. yes bestie, the one you're reading rn 💅
  • --info, -i — prompt before sensible changes. it's giving "are you sure?"

.devscripts value: SALSA_INFO (yes/no)

  • --path — repository path. Defaults to group or user path.

.devscripts value: SALSA_REPO_PATH

  • --token — token value (see above).
  • --token-file — file to find the token in (see above).
  • --user — username to use. If neither --group, --group-id, --user nor --user-id is set, salsa uses the current user ID (corresponding to the salsa private token).
  • --user-id — user ID to use. Use "salsa search_users name" to find one. If neither --group, --group-id, --user nor --user-id is set, salsa uses the current user ID (corresponding to the salsa private token).

.devscripts value: SALSA_USER_ID

  • --verbose — enable verbose output. tell me everything 🔥
  • --yes — never ask for consent. it just goes for it, consent is implied 💀

.devscripts value: SALSA_YES (yes/no)

🌈 List/search project options 🌈

  • --archived, --no-archived — instead of looking at active projects, list or search in archived projects. Note that you can't have both archived and unarchived projects in the same request. Default: no (ie --no-archived).

.devscripts value: SALSA_ARCHIVED (yes/no)

👑 Update/create project options 👑

  • --all, --all-archived — when set, all projects of the group/user are affected by the command. --all will filter all active projects, whereas --all-archived will include active and archived projects.
    • --skip, --no-skip — ignore projects with --all or --all-achived. Example:
salsa update_projects --tagpending --all --skip qa --skip devscripts

To set multiple values, use spaces. Example:

SALSA_SKIP=qa devscripts

Using --no-skip will ignore any projects to be skipped and include them.

.devscripts value: SALSA_SKIP

  • --skip-file — ignore projects in this file (1 project per line).
salsa update_projects --tagpending --all --skip-file ~/.skip

.devscripts value: SALSA_SKIP_FILE

  • --build-timeout — the maximum amount of time, in seconds, that a job can run. Default: 3600 (60 minutes).
salsa update_safe myrepo --build-timeout 3600

.devscripts value: SALSA_BUILD_TIMEOUT

  • --avatar-path — path to an image for the project's avatar. If the path value contains "%p", it's replaced by the project name.

.devscripts value: SALSA_AVATAR_PATH

  • --ci-config-path — configure the configuration file path of GitLab CI. Default: empty. Example: 🎀
salsa update_safe --ci-config-path recipes/debian.yml@salsa-ci-team/pipeline debian/devscripts

.devscripts value: SALSA_CI_CONFIG_PATH

  • --desc, --no-desc — configure a project's description using the pattern given in desc-pattern.

.devscripts value: SALSA_DESC (yes/no)

  • --desc-pattern — project's description pattern. "%p" is replaced by the project's name, while "%P" is replaced by the project's name given in the command (may contain the full path). Default: "Debian package %p".

.devscripts value: SALSA_DESC_PATTERN

  • --email, --no-email, --disable-email — enable, ignore or disable email-on-push. 📧

.devscripts value: SALSA_EMAIL (yes/ignore/no, default: ignore)

  • --email-recipient — email-on-push recipient. Can be multi valued:
$ salsa update_safe myrepo \
      --email-recipient foo@foobar.org \
      --email-recipient bar@foobar.org

If the recipient value contains "%p", it's replaced by the project name.

.devscripts value: SALSA_EMAIL_RECIPIENTS (use spaces to separate multiple recipients)

  • --analytics — set the analytics feature with permissions.

.devscripts value: SALSA_ENABLE_ANALYTICS (yes/private/no, default: yes)

  • --auto-devops — set the auto devops feature.

.devscripts value: SALSA_ENABLE_AUTO_DEVOPS (yes/no, default: yes)

  • --container — set the container feature with permissions.

.devscripts value: SALSA_ENABLE_CONTAINER (yes/private/no, default: yes)

  • --environments — set the environments feature with permissions.

Continuing the config line that belongs to that last toggle 👇 .devscripts value: SALSA_ENABLE_ENVIRONMENTS (yes/private/no, default: yes)

  • --feature-flags — sets the feature flags feature, with permissions. .devscripts value: SALSA_ENABLE_FEATURE_FLAGS (yes/private/no, default: yes)
  • --forks — sets the forking-a-project feature, with permissions. .devscripts value: SALSA_ENABLE_FORKS (yes/private/no, default: yes)
  • --infrastructure — sets the infrastructure feature, with permissions. .devscripts value: SALSA_ENABLE_INFRASTRUCTURE (yes/private/no, default: yes)
  • --issues — sets the issues feature, with permissions. .devscripts value: SALSA_ENABLE_ISSUES (yes/private/no, default: yes)
  • --jobs — sets the jobs feature, with permissions. .devscripts value: SALSA_ENABLE_JOBS (yes/private/no, default: yes)
  • --lfs — sets the Large File Storage (LFS) feature. .devscripts value: SALSA_ENABLE_LFS (yes/no, default: yes)
  • --mr — sets the merge requests feature, with permissions. .devscripts value: SALSA_ENABLE_MR (yes/private/no, default: yes)
  • --monitor — sets the monitor feature, with permissions. .devscripts value: SALSA_ENABLE_MONITOR (yes/private/no, default: yes)
  • --packages — sets the packages feature. .devscripts value: SALSA_ENABLE_PACKAGES (yes/no, default: yes)
  • --pages — sets the pages feature, with permissions. .devscripts value: SALSA_ENABLE_PAGES (yes/private/no, default: yes)
  • --releases — sets the releases feature, with permissions. .devscripts value: SALSA_ENABLE_RELEASES (yes/private/no, default: yes)
  • --enable-remove-source-branch, --disable-remove-source-branch — turns the "delete source branch" option on or off by default for all new merge requests. .devscripts value: SALSA_REMOVE_SOURCE_BRANCH (yes/no, default: yes)
  • --repo — sets the project's repository feature, with permissions. .devscripts value: SALSA_ENABLE_REPO (yes/private/no, default: yes)
  • --request-access — lets users ask to become a member. .devscripts value: SALSA_REQUEST_ACCESS (yes/no)
  • --requirements — sets the requirements feature, with permissions. .devscripts value: SALSA_ENABLE_REQUIREMENTS (yes/private/no, default: yes)
  • --security-compliance — switches the Security and Compliance feature on (or off). .devscripts value: SALSA_ENABLE_SECURITY_COMPLIANCE (yes/no)
  • --service-desk — allows the service desk feature. .devscripts value: SALSA_ENABLE_SERVICE_DESK (yes/no)
  • --snippets — sets the snippets feature, with permissions. .devscripts value: SALSA_ENABLE_SNIPPETS (yes/private/no, default: yes)
  • --wiki — sets the wiki feature, with permissions. .devscripts value: SALSA_ENABLE_WIKI (yes/private/no, default: yes)
  • --irc-channel — the IRC channel for KGB or Irker. You can only use it more than once with --irker.
Important, bestie: the channel must not include the leading #. If salsa finds a channel that starts with #, it will assume the channel actually starts with two #! 💀

.devscript value: SALSA_IRC_CHANNEL

Multiple values must be space separated.

And because configuration files get read using sh, be careful with #: you must wrap the channel in quotes, otherwise sh treats it as a comment and just ignores the value. 😭

  • --irker, --no-irker, --disable-irker — enable, ignore, or disable the Irker service. .devscripts value: SALSA_IRKER (yes/ignore/no, default: ignore)
  • --irker-host — Irker host. Default: ruprecht.snow-crash.org. .devscripts value: SALSA_IRKER_HOST
  • --irker-port — Irker port. Default: empty (default value). .devscripts value: SALSA_IRKER_PORT
  • --kgb, --no-kgb, --disable-kgb — enable, ignore, or disable the KGB webhook. .devscripts value: SALSA_KGB (yes/ignore/no, default: ignore)
  • --kgb-options — a comma separated list of the KGB options that are enabled. Default: issues_events, merge_requests_events, note_events, pipeline_events, push_events, tag_push_events, wiki_page_events, enable_ssl_verification

Like, for real, this is how you'd use it:

$ salsa update_safe debian/devscripts --kgb --irc-channel devscripts \
  --kgb-options 'merge_requests_events,issues_events,enable_ssl_verification'

The full list of available options goes: confidential_comments_events, confidential_issues_events, confidential_note_events, enable_ssl_verification, issues_events, job_events, merge_requests_events, note_events, pipeline_events, tag_push_events, wiki_page_events

.devscripts value: SALSA_KGB_OPTIONS

  • --no-fail — don't stop on error when you're using update_projects with --all or --all-archived, when it's set to yes. .devscripts value: SALSA_NO_FAIL (yes/no, default: no)
  • --no-wait — don't wait around for the server to confirm the changes. .devscripts value: SALSA_NO_WAIT (yes/no, default: no)
  • --rename-head, --no-rename-head — renames the HEAD branch given by --source-branch into --dest-branch and changes the project's "default branch". Only works with update_projects. .devscripts value: SALSA_RENAME_HEAD (yes/no)
    • --source-branch — Default: master. .devscripts value: SALSA_SOURCE_BRANCH
    • --dest-branch — Default: debian/latest. .devscripts value: SALSA_DEST_BRANCH
  • --tagpending, --no-tagpending, --disable-tagpending — enable, ignore, or disable the tagpending webhook. .devscripts value: SALSA_TAGPENDING (yes/ignore/no, default: ignore)
  • --debian-branch — sets the branch to update for the update_watch5 command. Defaults to the project's default branch. 🎀
  • --dep14 — use DEP-14 default branch mappings for the rename_branches command. .devscripts value: SALSA_DEP14 (yes/no)
  • --branch — branch to use for the file command. 🌿
  • --ref — ref to use for the file get command.
  • --commit-message — commit message to use for the file command. ✍️
  • --content-from-file — file to read content from, for the file command.

⏰ Pipeline schedules ⏰

  • --schedule-desc — description of the pipeline schedule.
  • --schedule-ref — branch or tag name that gets triggered.
  • --schedule-cron — the cron schedule. Example: 0 1 * * *.
  • --schedule-tz — time zone to run the cron schedule in. Default: UTC.
  • --schedule-enable, --schedule-disable — enable or disable the pipeline schedule running. Default: disabled.
  • --schedule-run — trigger the --schedule-desc scheduled pipeline to run immediately. Default: false.
  • --schedule-delete — delete the --schedule-desc pipeline schedule. 🗑️

🔥 CI status options 🔥

  • --retry-failed-pipelines — asks GitLab to retry pipelines that have failed. Get back up, king. 💅

💌 Merge requests options 💌

  • --mr-title — title for the merge request. Default: the last commit title.
  • --mr-desc — description of the new MR. Default:
    • empty, if --mr-title is set
    • the last commit description, if there is one
  • --mr-dst-branch (or second command line argument) — destination branch. Default: "master".
  • --mr-dst-project (or first command line argument) — destination project. Default: the project the current project was forked from; or, if that's not found, the "upstream" value found using git remote --verbose show; or the source project.

If --mr-dst-project is set to same, salsa will use the source project as the destination. 🔁

  • --mr-src-branch — source branch. Default: the current branch.
  • --mr-src-project — source project. Default: the current project, found using git remote --verbose show.
  • --mr-allow-squash, --no-mr-allow-squash — allow the upstream project to squash your commits. This is the default, bestie. ✨ .devscripts value: SALSA_MR_ALLOW_SQUASH (yes/no)
  • --mr-remove-source-branch, --no-mr-remove-source-branch — remove the source branch if the merge request gets accepted. Default: no. .devscripts value: SALSA_MR_REMOVE_SOURCE_BRANCH (yes/no)

🌍 Options to manage other GitLab instances 🌍

📝 Configuration file example 📝

Say you wanna use salsa with https://gitlab.ow2.org (group "lemonldap-ng"). You'd write:

SALSA_TOKEN=`cat ~/.ow2-gitlab-token`
SALSA_API_URL=https://gitlab.ow2.org/api/v4
SALSA_GIT_SERVER_URL=git@gitlab.ow2.org:
SALSA_GROUP_ID=34

And then to actually use it, drop something like this into your .bashrc file:

alias llng_admin='salsa --conffile ~/.salsa-ow2.conf'

Slay. 🫶

👀 SEE ALSO 👀

dpt-salsa

👑 AUTHOR 👑

Xavier Guimard <yadd@debian.org>

Copyright (C) 2018, Xavier Guimard <yadd@debian.org>

It contains code formerly found in dpt-salsa (pkg-perl-tools), copyright 2018, gregor herrmann <gregoa@debian.org>.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

And that's the whole thing, bestie 💖 this page ships as part of Debian Utilities, it's SALSA(1), and it's dated 2026-09-21. Go forth and automate, you absolute icon. 🌈✨

📦 where this page comes from