Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit 49e4bb72 authored by Karine Bauch's avatar Karine Bauch
Browse files

update README.md

parent 59bcaf03
No related branches found
No related tags found
No related merge requests found
...@@ -7,27 +7,8 @@ This template is for check json validity, with jq lib. ...@@ -7,27 +7,8 @@ This template is for check json validity, with jq lib.
## How to use it ## How to use it
Add the following in your `.gitlab-ci.yml` file. Add the following in your `.gitlab-ci.yml` file.
Variables are set with the inputs, in include section.
### As a remote Template (recommended) You can customize the job by overriding specific inputs.
#### Include the template:
```yaml
include:
- remote: 'https://lab.frogg.it/beebryte/cicd/templates/check_json/-/raw/0.1.0/templates/check_json.yml'
```
#### Customize the job:
You can customize the job by overriding specific keys. For example:
```yaml
check_json:
variables:
PROJECT_PATH: "path/to/my/project"
```
### As a local Template (if the template is local to the instance):
```yaml ```yaml
include: include:
...@@ -38,17 +19,10 @@ include: ...@@ -38,17 +19,10 @@ include:
project_path: 'path/to/my/project' project_path: 'path/to/my/project'
``` ```
## Variables ## Inputs
| Name | Description | Default |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| `PROJECT_PATH` | The path to the project root directory. | `"."` |
Default values are from inputs.
If you use this template as a local template, you can set the variables with inputs:
(see 'How to use it' section)
| Name | Description | Default | | Name | Description | Default |
|----------------|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| |----------------|-----------------------------------------|---------|
| `project_path` | The path to the project root directory. | `"."` | | `project_path` | The path to the project root directory. | `"."` |
| `stage` | The stage of the job. | `test` |
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment