Commit ee85f97e authored by Drousch's avatar Drousch
Browse files

Changes after Thomas feedback

parent b025180b

docs/create-update-job.md

+7 −7
Original line number Diff line number Diff line
@@ -32,9 +32,9 @@ able to work on it before merging your update in the real project. 


1. Create a new directory dedicated to your job in `jobs/` folder if you want to add a new job. You can use the [job

   template](https://gitlab.com/r2devops/hub/-/tree/latest/tools/job_template/job_name)

   as starting point.

   as starting point. If you want to modify an existing job, you don't have to create a new directory.

2. Be sure to respect the rules we describe in this guide.

3. Do not update the CI/CD configuration (file `.gitlab-ci.yml`).

3. Do not update the CI/CD configuration file `.gitlab-ci.yml`.

4. Test your job and ensure it works!



### 🚀 Step 3: Merge request
@@ -55,7 +55,7 @@ able to work on it before merging your update in the real project. 
          contribution is related to an existing issue, add a reference:

            ```md

            ## Contribution

            Addition of a new job permitting to build go binaries. Issue

            Addition of a new job permitting to build golang binaries. Issue

            related: r2devops/hub#945



            ## Definition of Done
@@ -282,7 +282,7 @@ interface: 
            when: always

        ```



#### 🔩 Keep genericity

#### 🔩 Keep your job generic



The jobs of the hub should remain as generic as possible. In order to ensure it:

docs/job-structure.md

+9 −6
Original line number Diff line number Diff line
@@ -27,9 +27,9 @@ follow this standardized structure: 
This file must have the same name as the job with the `yml` extension:

`<job_name>.yml`. It contains the Gitlab job configuration in `yaml` format.



    * The jobs of the hub use the Gitlab CI/CD configuration format. They must specify a Docker image to be run in a container.



!!! info

    * The jobs of the hub use the Gitlab CI/CD configuration format.

    * The jobs of the hub must specify a Docker image to be run in a container.

    * See [GitLab CI/CD pipeline configuration

      reference](https://docs.gitlab.com/ee/ci/yaml/){:target=blank}.

    * See [R2Devops guidelines and best
@@ -81,9 +81,9 @@ the following fields: 
| `default_stage` | Default stage of the job. You have to choose the most relevant stage from our [default stage list](/use-the-hub/#stages). We promise you will find the one you need!  | **Yes** |

| `maintainer` | Gitlab username of the maintainer (be proud of your work) | **Yes** |

| `license` | Open-source license for the job. You can choose between `Apache-2.0` and `MIT` | **Yes** |

| `labels` | List of labels describing the job | No |

| `images` | Dict of docker image(s) used by the job. Please entre the image name as key and the tag version as value | **Yes** |

| `tools` | Dict of tool(s) installed during the job. Please entre the name as key and the version as value  | No |

| `labels` | List of labels describing the job. It should describe a characteristic of your job. For example: Docker, PHP, Security, Quality... | No |

| `images` | Dictionary of docker image(s) used by the job. Please entre the image name as key and the tag version as value | **Yes** |

| `tools` | Dictionary of tool(s) installed during the job. Please entre the name as key and the version as value  | No |



**Here is an example of `job.yml` 👇**
@@ -105,6 +105,9 @@ labels: 


This file, named `README.md`, contains the documentation of a job  in `markdown` format. 



!!! info

      The documentation explains what the job does, how to use it and to customize it. A clear documentation is important: it guides the people using your job!



=== "Example of README.md"



    ```md