Merge branch '478-mdbook-build' into 'latest'

Yamllint

yamllint

zaproxy

mdBook

mdbook

Docusaurus

MDX

mdBook

webpack

Webpack

## Objective

The markdown documentation builder named [mdBook](https://github.com/rust-lang/mdBook){:target="_blank"} is done in Rust. It is used in documentation like [Rust by example](https://doc.rust-lang.org/rust-by-example/){:target="_blank"}.

This job would build the documentation of a mdBook project.

## How to use it

1. Ensure that you initialized a mdBook project with the `mdbook init` command. If you need more information about mdBook, please check the [documentation](https://github.com/rust-lang/mdBook){:target="_blank"}.

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

      - remote: 'https://jobs.r2devops.io/latest/mdbook_build.yml'

    ```

1. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

1. Well done, your job is ready to work ! 😀

## Job details

* Job name: `mdbook_build`

* Docker image:

[`rust:1.57-buster`](https://hub.docker.com/r/_/rust){:target="_blank"}

* Default stage: `build`

* When: `always`

### Variables

| Name | Description | Default |

| ---- | ----------- | ------- |

| `PROJECT_ROOT` <img width=100/> | Relative path in your repository to your mdBook project. <img width=175/>| `.` <img width=100/>|

| `DOCUMENTATION_OUTPUT` <img width=100/> | Relative path in your repository to the output produced by the `mdbook` build script. <img width=175/>| `website_build` <img width=100/>|

| `MDBOOK_VERSION` <img width=100/> | Version of `mdBook` used, by default the job will use the latest stable version of `mdBook`. <img width=175/>| ` ` <img width=100/>|

name: mdbook_build

description: The markdown documentation builder named mdBook is done in Rust. This job would build the documentation of a mdbook project.

default_stage: build

icon: 📘

maintainer: valentin.guyon.vg

license: Apache-2.0

images:

  "rust": "1.57-buster"

tools:

labels:

  - Rust

  - Build

  - mdBook

  - Documentation

# Job from R2Devops hub --> r2devops.io

stages:

  - build

mdbook_build:

  image:

    name: rust:1.57-buster

    entrypoint: [""]

  stage: build

  variables:

    PROJECT_ROOT: "."

    DOCUMENTATION_OUTPUT: "website_build"

    MDBOOK_VERSION: ""

  script:

    - cd ${PROJECT_ROOT}

    - |

        if [[ ${MDBOOK_VERSION} != "" ]]; then

            cargo install mdbook --vers "${MDBOOK_VERSION}"

        else

            cargo install mdbook

        fi

    - mdbook build --dest-dir ${CI_PROJECT_DIR}/${DOCUMENTATION_OUTPUT}

  artifacts:

    when: always

    paths:

      - ${CI_PROJECT_DIR}/${DOCUMENTATION_OUTPUT}