Commit 85b82acc authored by FulcrandG's avatar FulcrandG
Browse files

Merging branch 300

parents 6ca94973 c767458a

.gitlab-ci.yml

+5 −5
Original line number Diff line number Diff line
@@ -155,20 +155,20 @@ links_checker: 
  allow_failure: true



# See https://docs.gitlab.com/ee/api/labels.html

job_labels:

job_gitlab_labels:

  image: python:3.9.1-alpine

  stage: project_setup

  variables:

    PIPENV_PIPFILE: tools/job_labels/Pipfile

    JOB_LOGFILE: "job_labels.log"

    PIPENV_PIPFILE: tools/job_gitlab_labels/Pipfile

    JOB_LOGFILE: "job_gitlab_labels.log"

    PYTHONPATH: "./:$PYTHONPATH"

  before_script:

    - pip install --ignore-installed distlib pipenv

    - pipenv install

  script:

    - pipenv run python3 tools/job_labels/job_labels.py

    - pipenv run python3 tools/job_gitlab_labels/job_gitlab_labels.py

  artifacts:

    expose_as: "job_labels"

    expose_as: "job_gitlab_labels"

    paths:

      - ${JOB_LOGFILE}

    expire_in: 30 days

docs/css/extra.css

+0 −1
Original line number Diff line number Diff line
@@ -236,7 +236,6 @@ button.md-button-center { 
    display:block !important;

    margin:0 auto !important;

    padding-bottom:1em !important;

    padding-top:0.8em !important

    padding-top:0.8em !important;

}

jobs/apidoc/README.md

+1 −1
Original line number Diff line number Diff line 
## Objective



Creates a versioned HTML documentation from API annotations in your source

code using [apiDoc](https://www.apidocjs.com/){:target="_blank"}.

code using [apiDoc](https://apidocjs.com/){:target="_blank"}.



## How to use it

jobs/lighthouse/README.md

+17 −12
Original line number Diff line number Diff line
@@ -13,22 +13,26 @@ This job analyzes a remote website (or a local web service) and gives you a repo 
    include:

      - remote: 'https://jobs.r2devops.io/lighthouse.yml'

    ```

2. Choose a target



    !!! note

        This job can be run on external services or by running a container

        instance of your website. **You need to choose between two following

        options**.

2. Choose a target



    * Option 1: external service

    !!! tip "Plug and play available !"

      This job is **plug and play** 🚀, see the Option 1.<br/>

      Other options need some configuration.<br/><br/>

      **Using one of these option is mandatory to job success**



    Add the site IP or the domain name of the service in `LIGHTHOUSE_TARGET` variable

    (see [jobs customization](http://localhost:8000/use-the-hub/#jobs-customization))

    ??? summary "Option 1: Choose the **plug and play** 🚀 mode"

      😎 You have nothing to do, you can go to the next step.<br/><br/>If you are using one of hub building job to build a static website, **prefer to choose this option.**<br/>

      Your static website will be directly used by lighthouse !

      <br/><br/>*In case you updated the artifact path in your building job, don't forget to update `PAGES_PATH` variable.*



    *  Option 2: container instance

    ??? summary "Option 2: Plug manually your external website"

      Add the site IP or the domain name of the service to check in `LIGHTHOUSE_TARGET` variable

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



    ??? summary "Option 3: Plug manually your container instance"

      Add the target container instance as a service (see

    [Container instance as Service](/use-the-hub/#container-instance-as-service)) and

      [Container instance as Service](/use-the-hub/#advanced-services)) and

      set variable `LIGHTHOUSE_TARGET` as the name of your container.



3. If you need to customize the job (stage, variables, ...) 👉 check the [jobs
@@ -52,6 +56,7 @@ This job analyzes a remote website (or a local web service) and gives you a repo 
| `OUTPUT_FORMAT` | Format of report file (`json`, `csv`, `html`) | `html` |

| `OUTPUT_LOCALE` | Language of report file | `en` |

| `ADDITIONAL_OPTIONS` | Variable to add custom options (see [options](https://github.com/GoogleChrome/lighthouse#cli-options){:target="_blank"}) | ` ` |

| `PAGES_PATH` | Path of your static website (not used if `LIGHTHOUSE_TARGET` is filled) | `website_build/` |



### Audit configuration

jobs/lighthouse/job.yml

+1 −1
Original line number Diff line number Diff line 
name: lighthouse

description: A simple job to do various tests on a site using Google Lighthouse

description: A simple job to do various tests on a website using Google Lighthouse

default_stage: dynamic_tests

icon: 🗽

maintainer: Protocole