Gérer les utilisateurs et les groupes¶

join

Demander l'accès à un groupe.

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

add_user

Ajouter un utilisateur à un groupe.

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

Le premier argument est le niveau d'accès GitLab : guest, reporter, developer, maintainer, owner.

del_user

Retire un utilisateur d'une équipe

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

list_groups

Liste les groupes subordonnés si un groupe est indiqué, les groupes de l'utilisateur courant sinon.

group

Montre les membres d'un groupe.

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

search_group

Cherche un groupe en utilisant la chaîne indiquée. Montre l'id du groupe et d'autres informations.

  salsa search_group perl-team
  salsa search_group perl-team/modules
  salsa search_group 2666
    

search_user

Cherche un utilisateur en utilisant la chaîne indiquée. Montre l'id de l'utilisateur et d'autres informations.

  salsa search_user yadd
    

update_user

Met à jour le rôle dans un groupe.

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

Le premier argument est le niveau d'accès GitLab : guest, reporter, developer, maintainer, owner.

whoami

Affiche les informations du propriétaire du jeton

  salsa whoami
    

Gérer les dépôts¶

Une seule option parmi "--group", "--group-id", "--user" et "--user-id" est nécessaire pour gérer les répertoires. Si les 2 sont indiquées, salsa avertit et utilise seulement "--user"/"--user-id". Si aucune n'est indiquée, salsa utilise l'id du propriétaire du jeton.

check_repo

Vérifie que le(s) dépot(s) est/sont correctement configuré(s). Fonctionne exactement comme update_repo si ce n'est qu'il ne modifie rien mais liste simplement les projets mal configurés avec les erreurs trouvées.

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

checkout or co

Duplique (clone) le dépôt dans le répertoire courant. Si le répertoire de destination existe, met à jour le dépôt local.

  salsa --user yadd co devscripts
  salsa --group js-team co node-mongodb
  salsa co js-team/node-mongodb
    

Il est possible de dupliquer plus d'un dépôt ou tous les dépôts d'un groupe ou d'un utilisateur :

  salsa --user yadd co devscripts autodep8
  salsa co yadd/devscripts js-team/npm
  salsa --group js-team co --all           # All js-team repos
  salsa co --all                           # All your repos
    

create_repo

Crée un projet public vide. Si "--group"/"--group-id" est utilisé, le projet est créé dans le répertoire du groupe, sinon dans celui de l'utilisateur.

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

del_repo

Supprimer un dépôt.

fork

Duplique (fork) un projet dans le répertoire du groupe/utilisateur et insère une cible git "upstream" pointant sur le projet d'origine. Exemple :

  $ 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)
    

Pour un groupe :

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

forks

Liste les duplications (forks) du/des projet(s).

  salsa forks qa/qa debian/devscripts
    

Le projet peut être indiqué en utilisant le chemin complet ou --group/--group-id ou encore --user/--user-id ; sinon il est recherché dans l'espace de l'utilisateur.

push

Poussez les références pertinentes du paquet vers le dépôt Git "origin". À exécuter à partir du répertoire de travail d'empaquetage.

  salsa push
    

Il pousse les références suivantes vers le dépôt amont configuré pour la branche debian-branch ou, à défaut, vers le dépôt "origin" :

ls or list_repos

Montre les projets propriété de l'utilisateur ou du groupe. Si un second argument est donné, restreint la recherche aux projets correspondants

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

last_ci_status or ci

Affiche le dernier résultat de l'intégration continue. Utiliser --verbose pour afficher l'URL du résultat lorsque le résultat est différent de success. À moins que l'option --no-fail ne soit choisie, salsa last_ci_status s'arrêtera au premier statut "failed" trouvé.

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

Cette commande retourne le nombre de statuts "failed" trouvés. Les entrées "success" sont affichées en utilisant la sortie standard STDOUT et les autres sont affichées (avec les détails) en utilisant STDERR? Ainsi on peut facilement ne voir que les échecs en utilisant :

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

merge_request, mr

Crée une "merge request".

Supposons qu'un dépôt ait été créé avec salsa fork, qu'une modification en un seul commit ait été fait et que l'on souhaite la proposer au projet originel (branche "master"). Il suffit de lancer ceci dans le répertoire source :

  salsa mr
    

Autres exemples :

  salsa mr --mr-dst-project debian/foo --mr-dst-branch debian/master
    

ou simplement

  salsa mr debian/foo debian/master
    

Noter qu'à moins que le projet de destination ait été explicitement indiqué dans la ligne de commande, salsa merge_request le cherche dans l'ordre suivant :

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

merge_requests, mrs

Liste les "merge requests" ouvertes pour ce(s) projet(s)

  salsa mrs qa/qa debian/devscripts
    

Le projet peut être indiqué en utilisant le chemin complet ou --group/--group-id ou encore --user/--user-id ; sinon il est recherché dans l'espace de l'utilisateur.

protect_branch

Protège/dé-protège une branche.

protected_branches

Liste les branches protégées

  salsa --group js-team protected_branches node-mongodb
    

push_repo

Créer un nouveau projet depuis un répertoire local de source Debian configuré avec git.

push_repo executes the following steps:

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

rename_branch

Renomme la branche indiquée dans --source-branch avec le nom donné dans --dest-branch. On peut utiliser les options --no-fail et --all ici.

search, search_project, search_repo

Cherche un projet en utilisant la chaîne donnée. Montre le nom, l'id du propriétaire et d'autres informations.

  salsa search devscripts
  salsa search debian/devscripts
  salsa search 18475
    

update_repo

Configure le(s) dépôt(s) en utilisant les paramètres donnés dans la ligne de commande. Un nom de dépôt doit être donné à moins que --all ne soit utilisé. Préférer update_safe.

  salsa --user yadd --tagpending --kgb --irc=devscripts update_repo test
  salsa --group js-team update_repo --all
  salsa --group js-team --rename-head update_repo test1 test2 test3
  salsa update_repo js-team/node-mongodb --kgb --irc debian-js
    

Par défaut lorsque --all est utilisé, salsa échoue à la première erreur. Pour pouvoir continuer, indiquer --no-fail. Dans ce cas, salsa affichera un avertissement pour chaque projet en échec mais continuera avec le projet suivant. Pour voir alors les erreurs complètes, utiliser --verbose.

update_safe

Lance check_repo et demande avant de lancer update_repo (sauf si --yes).

  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
    

Autre¶

purge_cache

Cache local vide.

Options générales¶

-C, --chdir

Changer de répertoire avant de lancer la commande

  salsa -C ~/debian co debian/libapache2-mod-fcgid
    

--cache-file

Fichier où stocker les valeurs cachées. Défaut : ~/.cache/salsa.json. Une valeur vide désactive le cache.

Valeur ".devscripts" : SALSA_CACHE_FILE

--no-cache

Désactive le cache. Identique à --cache-file ''

--conffile, --conf-file

Ajoute ou remplace les fichiers de configuration par défaut ("/etc/devscripts.conf" and "~/.devscripts"). L'option ne peut être utilisée qu'en première position de la ligne de commande.

--no-conf, --noconf

Ne lire aucun fichier de configuration. L'option ne peut être utilisée qu'en première position de la ligne de commande.

--debug

Active l'affichage verbeux

--group

Équipe à utiliser. Utiliser "salsa search_group nom" pour le trouver.

Pour utiliser un sous-groupe, il faut en saisir le chemin complet :

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

Valeur ".devscripts" : SALSA_GROUP

Attention en utilisant SALSA_GROUP dans votre fichier ".devscripts". Toutes les commandes salsa seront exécutées dans l'espace du groupe. Par exemple si vous voulez proposer un léger changement dans un projet en utilisant salsa fork + salsa mr, ce "fork" sera fait dans l'espace du groupe sauf si vous indiquez un --user/--user-id. Préférez utiliser un alias dans votre fichier ".bashrc". Exemple :

  alias jsteam_admin="salsa --group js-team"
    

ou

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

ou pour utiliser à la fois .devscripts et .js.conf :

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

on peut alors indiquer SALSA_GROUP dans "~/.js.conf"

Pour activer l'autocomplétion bash pour l'alias, ajouter ceci dans le fichier ".bashrc" :

  _completion_loader salsa
  complete -F _salsa_completion jsteam_admin
    

--group-id

Groupe à utiliser. Utiliser "salsa search_group nom" pour le trouver.

Valeur ".devscripts" : SALSA_GROUP_ID

Attention en utilisant SALSA_GROUP dans votre fichier ".devscripts". Toutes les commandes salsa seront exécutées dans l'espace du groupe. Par exemple si vous voulez proposer un léger changement dans un projet en utilisant salsa fork + salsa mr, ce "fork" sera créé dans l'espace du groupe sauf si vous indiquez un --user/--user-id. Préférez utiliser un alias dans votre fichier ".bashrc". Exemple :

  alias jsteam_admin="salsa --group-id 2666"
    

ou

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

on peut alors indiquer SALSA_GROUP_ID dans "~/.js.conf"

--help: affiche cette page de manuel

-i, --info

Demander avant les changements sensibles.

Valeur ".devscripts" : SALSA_INFO (yes/no)

--path

Chemin du dépôt. Par défaut, chemin du groupe ou de l'utilisateur.

Valeur ".devscripts" : SALSA_REPO_PATH

--token

Valeur du jeton (voir ci-avant).

--token-file

Fichier où trouver le jeton (voir ci-avant).

--user

Id de l'utilisateur à utiliser. Si aucun --group, --group-id, --user or --user-id n'est indiqué, salsa utilise l'id du propriétaire du jeton.

--user-id

Id de l'utilisateur à utiliser. Utiliser "salsa search_user nom" pour le trouver. Si aucun --group, --group-id, --user ou --user-id n'est indiqué, salsa utilise l'id du propriétaire du jeton.

Valeur ".devscripts" : SALSA_USER_ID

--verbose

Affiche plus de logs.

--yes

Ne jamais demander de consentement.

Valeur ".devscripts" : SALSA_YES (yes/no)

Options de liste/recherche¶

--archived --no-archived

Au lieu d'examiner dans les projets actifs, liste ou cherche dans les projets archivés. Noter qu'on ne peut avoir des projets archivés et non-archivés dans la même requête. Défaut: no (ie --no-archived).

Valeur ".devscripts" : SALSA_ARCHIVED (yes/no)

Options pour mettre à jour ou créer des dépôts¶

--all

Lorsqu'indiqué, tous les projets du groupe/utilisateur sont affectés par la commande.

--ci-config-path

Configure le chemin du fichier de configuration de la CI GitLab. Défaut : vide. Exemple :

  salsa update_safe --ci-config-path recipes/debian.yml@salsa-ci-team/pipeline debian/devscripts
    

Valeur ".devscripts" : SALSA_CI_CONFIG_PATH

--desc --no-desc

Configure la description du dépôt en utilisant l'expression donnée avec --desc-pattern

Valeur ".devscripts" : SALSA_DESC (yes/no)

--desc-pattern

Expression de description des dépôts. Défaut : "Debian package %p". "%p" est remplacé par le nom du dépôt, "%P" est remplacé par le nom du dépôt donné dans la commande (peut contenir le chemin complet).

Valeur ".devscripts" : SALSA_DESC_PATTERN

--email, --no-email, --disable-email

Active, ignore ou désactive email-on-push.

Valeur ".devscripts" : SALSA_EMAIL (yes/ignore/no, défaut : ignore)

--email-recipient

Destinataire Email-on-push. Peut être multi-valué :

  $ salsa update_safe myrepo \
        --email-recipient foo@foobar.org \
        --email-recipient bar@foobar.org
    

Si la chaîne destinataire contient la macro "%p", elle sera remplacée par le nom du projet.

Valeur ".devscripts" : SALSA_EMAIL_RECIPIENTS (utiliser des espaces pour séparer les destinataires multiples)

--enable-issues, --no-enable-issues, --disable-issues, --no-disable-issues

Active, ignore ou désactive l'ouverture de bogues.

Valeurs ".devscripts" : SALSA_ENABLE_ISSUES (yes/ignore/no, défaut: ignore)

--enable-mr, --no-enable-mr, --disable-mr, --no-disable-mr

Active, ignore ou désactive les "merge requests".

Valeurs ".devscripts" : SALSA_ENABLE_MR (yes/ignore/no, défaut: ignore)

--irc-channel

Canal IRC pour KGB et Irker. Peut être utilisé plusieurs fois uniquement avec --irker.

Important : le canal ne doit pas inclure le premier "#". Si salsa trouve une chaîne commençant par "#", il considerera que le canal démarre par 2 "#" !

Valeur ".devscripts" : SALSA_IRC_CHANNEL.

Les valeurs multiples doivent être séparées par des espaces.

Comme le fichier de configuration est lu en utilisant sh, être prudent lorsque "#" est utilisé : il faut alors encadré le canal par des guillemets, sinon sh le considerera comme commentaire et ignorera cette valeur.

--irker, --no-irker, --disable-irker

Active, ignore ou désactive Irker

Valeur ".devscripts" : SALSA_IRKER (yes/ignore/no, défaut : ignore)

--irker-host

Hôte Irker. Défaut : ruprecht.snow-crash.org

Valeur ".devscripts" : SALSA_IRKER_HOST

--irker-port

Hôte Irker. Défaut : vide (valeur par défaut)

Valeur ".devscripts" : SALSA_IRKER_Port

--kgb, --no-kgb, --disable-kgb

Active, ignore ou désactive le webhook KGB.

Valeur ".devscripts" : SALSA_KGB (yes/ignore/no, défaut : ignore)

--kgb-options

Liste des options KGB activées (séparées par des virgules). Défaut : issues_events, merge_requests_events, note_events, pipeline_events, push_events, tag_push_events, wiki_page_events, enable_ssl_verification

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

Liste des options disponibles : 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

Valeur ".devscripts" : SALSA_KGB_OPTIONS

--no-fail

Ne pas s'arrêter à la première erreur lorsque update_repo est utilisé avec --all.

Valeur ".devscripts" : SALSA_NO_FAIL (yes/no)

--rename-head, --no-rename-head

Renommer la branche HEAD indiquée par --source-branch en --dest-branch et changer la branche par défaut. Ne fonctionne qu'avec update_repo.

Valeur ".devscripts" : SALSA_RENAME_HEAD (yes/no)

--tagpending, --no-tagpending, --disable-tagpending

Active, ignore ou désactive le webhook "tagpending".

Valeur ".devscripts" : SALSA_TAGPENDING (yes/ignore/no, défaut : ignore)

Options pour les "merge requests"¶

--mr-title

Titre à utiliser. Défaut : titre du dernier commit.

--mr-desc

Description à utiliser. Défaut :

--mr-dst-branch(ou second argument de la ligne de commande)

Branche de destination. Défaut : "master".

--mr-dst-projet(ou premier argument de la ligne de commande)

Projet de destination. Défaut : projet duquel ce projet a été cloné ; sinon, la valeur "upstream" retournée en utilisant git remote --verbose show ; à défaut le projet courant.

Si --mr-dst-project est mis à same, salsa utilisera le projet source comme destination.

--mr-src-branch

Branche source. Défaut : branche courante.

--mr-src-project

Projet source. Défaut : projet courante trouvé en utilisant git remote --verbose show.

--mr-allow-squash, --no-mr-allow-squash

Autorise le projet amont à regrouper les commits (squash), c'est la valeur par défaut.

Valeur ".devscripts" : SALSA_MR_ALLOW_SQUASH (yes/no)

--mr-remove-source-branch, --no-mr-remove-source-branch

Effacer la branche source si la requête est acceptée. Défaut : no.

Valeur ".devscripts" : SALSA_MR_REMOVE_SOURCE_BRANCH (yes/no)

Options pour gérer d'autres instance GitLab¶

--api-url

API GitLab. Défaut : <https://salsa.debian.org/api/v4>.

Valeur ".devscripts" : SALSA_API_URL

--git-server-url

Défaut : "git@salsa.debian.org:"

Valeur ".devscripts" : SALSA_GIT_SERVER_URL

--irker-server-url

Défaut : "ircs://irc.oftc.net:6697/"

Valeur ".devscripts" : SALSA_IRKER_SERVER_URL

--kgb-server-url

Défault : <http://kgb.debian.net:9418/webhook/?channel=>

Valeur ".devscripts" : SALSA_KGB_SERVER_URL

--tagpending-server-url

Défaut : <https://webhook.salsa.debian.org/tagpending/>

Valeur ".devscripts" : SALSA_TAGPENDING_SERVER_URL

Exemple de fichier de configuration

Exemple pour utiliser salsa avec <https://gitlab.ow2.org> (groupe "lemonldap-ng"):

  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

Ensuite pour l'utiliser, ajouter quelque chose comme suit dans votre fichier ".bashrc" :

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