Commit 1cdf49b4 authored by Emeric Verschuur's avatar Emeric Verschuur Committed by Brian Lee

[README] README files typo fix

parent 2511b910
......@@ -3,15 +3,15 @@
Cette boîte à outils peut être utilisée pour
* exécuter une tâche Gitlab en dehors d'un exécuteur de tâche Gitlab (outil `gitlab-runner`) sur votre poste de travail (fonction de base)
* écrire la partie script en utilisant une sctructure modulaire (fonction avancée)
* écrire la partie script en utilisant une structure modulaire (fonction avancée)
## Table des matières
* [Le projet](#le-projet)
* [Installation des outils ci-toolbox](#installation-des-outils-ci-toolbox)
* [Mise à jours des outils ci-toolbox](#mise-à-jours-des-outils-ci-toolbox)
* [Installation de l'outil ci-toolbox](#installation-de-loutil-ci-toolbox)
* [Mise à jours de l'outil ci-toolbox](#mise-à-jours-de-loutil-ci-toolbox)
* [Intégration dans une arborescence projet](#intégration-dans-une-arborescence-projet)
* [Mise à jour des outils ci-toolbox du projet](#mise-à-jour-des-outils-ci-toolbox-du-projet)
* [Mise à jour de l'outil ci-toolbox du projet](#mise-à-jour-de-loutil-ci-toolbox-du-projet)
* [Cas d'utilisation : Tâche de pipeline Gitlab standard](#cas-dutilisation--tâche-de-pipeline-gitlab-standard)
* [Exécuter une tâche spécifique localement](#exécuter-une-tâche-spécifique-localement)
* [Première solution : utiliser l'outil gitlab-runner](#première-solution--utiliser-loutil-gitlab-runner)
......@@ -29,14 +29,14 @@ Cette boîte à outils peut être utilisée pour
## Le projet
Les outils ci-toolbox penvent être installé dans le système et/ou intégré dans l'arborescence de votre project (ce qui est utile pour forcer l'équipe du projet à utiliser une version spécigique et ainsi maîtriser les mises à jours)
L'outil ci-toolbox peut être installé dans le système et/ou intégré dans l'arborescence de votre projet (ce qui est utile pour forcer l'équipe du projet à utiliser une version spécifique et ainsi maîtriser les mises à jours)
La commande ci-toolbox (`/usr/local/bin/ci-toolbox`) est un outil intermédiaire qui va appeler `tools/ci-toolbox/ci-toolbox.sh` depuis le projet si il est trouvé dedans, autrement, il va exécuter celui installé dans le système (`/usr/local/lib/ci-toolbox/ci-toolbox.sh`)
### Installation des outils ci-toolbox
### Installation de l'outil ci-toolbox
L'installation peut se faire :
* Manuellement en clonant le porget et en lançant le script `./tools/ci-toolbox/ci-toolbox.sh setup`
* Manuellement en clonant le projet et en lançant le script `./tools/ci-toolbox/ci-toolbox.sh setup`
* En copiant ce qui suit dans une invite de commande (en remplaçant si besoin 'master' par le numéro de version choisi dans l'URL) :
```bash
......@@ -49,13 +49,13 @@ mkdir -p /tmp/ci-toolbox \
&& rm -rf /tmp/ci-toolbox
```
### Mise à jours des outils ci-toolbox
### Mise à jours de l'outil ci-toolbox
Il suffit de taper la commande `ci-toolbox setup --component ci-tools` ou `ci-toolbox setup --component ci-tools <custom_version>`
### Intégration dans une arborescence projet
Cas d'intégration des outils ci-toolbox dans une arborescence projet :
Cas d'intégration de l'outil ci-toolbox dans une arborescence projet :
```
├── .gitlab-ci.yml
├── tools
......@@ -91,9 +91,9 @@ Liste des éléments pour une utilisation avancée :
* `jobs` : dossier contenant les fonctions spécifiques aux différentes tâches
* `modules` : dossier contenant les modules
### Mise à jour des outils ci-toolbox du projet
### Mise à jour de l'outil ci-toolbox du projet
La commande `ci-toolbox update` ou `ci-toolbox update <custom_version>` permet de mettre à jour les outils ci-toolbox de votre projet
La commande `ci-toolbox update` ou `ci-toolbox update <custom_version>` permet de mettre à jour de l'outil ci-toolbox de votre projet
## Cas d'utilisation : Tâche de pipeline Gitlab standard
......
......@@ -3,15 +3,15 @@
This toolbox can be used to
* run Gitlab-CI jobs outside a runner on your workstation (classical use case)
* write the script part using a modularized format (advanced use case)
* write the script part using a modular format (advanced use case)
## Table of contents
* [The project](#the-project)
* [System side ci-toolbox tools setup](#system-side-ci-toolbox-tools-setup)
* [System side ci-toolbox tools update](#system-side-ci-toolbox-tools-update)
* [ci-toolbox tools integration in a project](#ci-toolbox-tools-integration-in-a-project)
* [ci-toolbox tools upgrade from a project](#ci-toolbox-tools-upgrade-from-a-project)
* [System side ci-toolbox tool setup](#system-side-ci-toolbox-tool-setup)
* [System side ci-toolbox tool update](#system-side-ci-toolbox-tool-update)
* [ci-toolbox tool integration in a project](#ci-toolbox-tool-integration-in-a-project)
* [ci-toolbox tool upgrade from a project](#ci-toolbox-tool-upgrade-from-a-project)
* [Use case: Standard Gitlab-CI pipeline job](#use-case-standard-gitlab-ci-pipeline-job)
* [Run a specific job locally](#run-a-specific-job-locally)
* [First solution: using gitlab-runner tool](#first-solution-using-gitlab-runner-tool)
......@@ -29,11 +29,11 @@ This toolbox can be used to
## The project
The ci-toolbox tools can be installed into the system and/or also integrated into a project tree (useful to force the project team to use a specific version)
The ci-toolbox tool can be installed into the system and/or also integrated into a project tree (useful to force the project team to use a specific version)
The ci-toolbox command (`/usr/local/bin/ci-toolbox`) is a wrapper which will execute `tools/ci-toolbox/ci-toolbox.sh` from the project if found here, otherwise, the ci-toolbox wrapper will use this stored into system (`/usr/local/lib/ci-toolbox/ci-toolbox.sh`)
### System side ci-toolbox tools setup
### System side ci-toolbox tool setup
You can perform this setup (where `master` can be changed by a specific version in the URL):
* Manually by cloning this project and execute `tools/ci-toolbox/ci-toolbox.sh setup`
......@@ -49,13 +49,13 @@ mkdir -p /tmp/ci-toolbox \
&& rm -rf /tmp/ci-toolbox
```
### System side ci-toolbox tools update
### System side ci-toolbox tool update
You can update simply with the command `ci-toolbox setup --component ci-tools` or `ci-toolbox setup --component ci-tools <custom_version>`
### ci-toolbox tools integration in a project
### ci-toolbox tool integration in a project
Case of integration of ci-toolbox tools into your project:
Case of integration of ci-toolbox tool into your project:
```
├── .gitlab-ci.yml
├── tools
......@@ -91,9 +91,9 @@ The advanced additional element list:
* `jobs`: directory containing job specific functions
* `modules`: directory containing the modules
### ci-toolbox tools upgrade from a project
### ci-toolbox tool upgrade from a project
You can update embedded ci-toolbox tools simply by run `ci-toolbox update` ou `ci-toolbox update <custom_version>`
You can update embedded ci-toolbox tool simply by run `ci-toolbox update` ou `ci-toolbox update <custom_version>`
## Use case: Standard Gitlab-CI pipeline job
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment