Commit d90c8058 authored by Thibaud-Vdb's avatar Thibaud-Vdb
Browse files

Merge branch '558-resolve-links_checker-job' into 'latest' 

Resolve "Resolve links_checker job"

Closes #558

See merge request r2devops/hub!340
parents e44dc369 e02250b6

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -165,7 +165,7 @@ links_checker: 
  variables:

    # The following hard excluded link is due that this

    # job will be migrated to a new tool soon (see #314)

    LICHE_EXCLUDE: ^([^http]|https://gitlab.com/r2devops/hub/-/forks/new)

    LICHE_EXCLUDE: ^([^http]|https://gitlab.com/r2devops/hub/-/forks/new)|^([^http]|https://r2devops.io/.+)

    FAIL_ON_BROKEN: "true"

    LICHE_DIRECTORY: "docs/"

  allow_failure: true

docs/create-update-job.md

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ able to work on it before merging your update in the real project. 
        * Click on `Compare branches and continue`.

    1. In `Title`: add short description of your contribution.

    1. In `Description`:

        * Do not remove the default content, this is the [Definition of Done (DoD)](https://go2scale.io/definition-of-done-a-recipe-for-optimal-results/)!

        * Do not remove the default content, this is the Definition of Done (DoD)

        * Add a description of your contribution with all information

          permitting us to understand what you have done and why. If your

          contribution is related to an existing issue, add a reference:

docs/job-structure.md

+1 −1
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ Job definition usually contains the following fields: 
* **[`variables`](https://docs.gitlab.com/ee/ci/yaml/#variables){:target="_blank"}**: in this field, you will find all the variables used by the `script` of the job. This is where you customize its behavior.

* **[`artifacts`](https://docs.gitlab.com/ee/ci/yaml/#artifacts){:target="_blank"}**: it specifies the result of the job that should be exposed to the user through classic artifact or Gitlab reports.



**Here is an example of job definition [`apidoc.yml`](https://r2devops.io/jobs/build/apidoc/) 👇**

**Here is an example of job definition [`apidoc.yml`](https://r2devops.io/_/r2devops-bot/apidoc/) 👇**



```yaml

apidoc:

docs/use-the-hub.md

+6 −6
Original line number Diff line number Diff line
@@ -84,17 +84,17 @@ Follows these steps to setup your CI/CD pipeline in less than 5 minutes ! 
    !!! info "Jobs used in the example"

        * Plug-and-play set of jobs from the hub to automatically build, test

          and deploy static documentation website:

            * [`mkdocs`](https://r2devops.io/jobs/build/mkdocs/) (`latest`

            * [`mkdocs`](https://r2devops.io/_/r2devops-bot/mkdocs/) (`latest`

              version)

            * [`lighthouse`](https://r2devops.io/jobs/dynamic_tests/lighthouse/)

            * [`lighthouse`](https://r2devops.io/_/r2devops-bot/lighthouse/)

              (`latest` version)

            * [`pages`](https://r2devops.io/jobs/deploy/pages/) (`latest`

            * [`pages`](https://r2devops.io/_/r2devops-bot/pages/) (`latest`

              version)

        * Plug-and-play set of jobs from the hub to automatically build, push

          and test docker images:

            * [`docker_build`](https://r2devops.io/jobs/build/docker_build/)

            * [`docker_build`](https://r2devops.io/_/r2devops-bot/docker_build)

              (version `0.3.0`)

            * [`trivy_image`](https://r2devops.io/jobs/dynamic_tests/trivy_image/)

            * [`trivy_image`](https://r2devops.io/_/r2devops-bot/trivy_image/)

              (version `0.2.0`)

        * A custom manual job `unit_tests`
@@ -205,7 +205,7 @@ to a job: [`services`](https://docs.gitlab.com/ee/ci/yaml/#services). 


To use this option, you must have access to an image of the container you want

to run as a service. For example, if you are using our

[docker_build](https://r2devops.io/jobs/build/docker_build/) job to build an

[docker_build](https://r2devops.io/_/r2devops-bot/docker_build) job to build an

image of your application, and you want to test this image using the

[nmap](/jobs/dynamic_tests/nmap/) job, just add the following configuration in

your `.gitlab-ci.yml` file:

jobs/apidoc/CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [0.3.1] - 2022-04-06

* Change old link in the job code



## [0.3.0] - 2021-03-22

* Add `APIDOC_SOURCE_PATH` variable

* Add `APIDOC_INCLUDE_FILTER` variable