Commit 5a5f4a12 authored by Thomas Boni's avatar Thomas Boni
Browse files

Merge branch '27-use-an-url-shortener' into 'latest' 

Resolve "Use an url shortener"

Closes #27

See merge request go2scale/hub!4
parents c972ea9b 89cdaa62

docs/Jobs/mkdocs/README.md

+6 −5
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ Mkdocs](https://squidfunk.github.io/mkdocs-material/) are ready to use. 


    ```yaml

    include:

      - remote: 'https://gitlab.com/go2scale/hub/-/raw/latest/Jobs/mkdocs/mkdocs.yml'

      - remote: 'https://jobs.go2scale.io/mkdocs'

    ```



4. If you need set variables in jobs, use `variables` option in
@@ -43,15 +43,15 @@ Build HTML documentation from Makdown source using `Mkdocs`. 


## Versions



* **Latest** : `https://gitlab.com/go2scale/jobs/-/raw/latest/Jobs/mkdocs/mkdocs.yml`

* **Tag `2020-07-13_1`** : `https://gitlab.com/go2scale/hub/-/raw/2020-07-31_1/Jobs/mkdocs/mkdocs.yml`

* **Latest** : `https://jobs.go2scale.io/mkdocs/latest`

* **Tag `2020-07-15_1`** : `https://jobs.go2scale.io/mkdocs/2020-07-15_1`



    !!! warning

        Since this version, `pages` job, which publish documentation on Gitlab

        pages, isn't included anymore. It's now a dedicated job:

        [pages](Jobs/pages).



* **Tag `2020-05-31_1`** : `https://gitlab.com/go2scale/hub/-/raw/2020-05-31_1/Jobs/mkdocs/mkdocs.yml`

* **Tag `2020-05-31_1`** (legacy): `https://gitlab.com/go2scale/hub/-/raw/2020-05-31_1/jobs/documentation.gitlab-ci.yml`



    !!! warning

        This update introduces breaking changes. Follow [this
@@ -59,5 +59,6 @@ Build HTML documentation from Makdown source using `Mkdocs`. 
        to know how to upgrade.

    * Upgrade Material for Mkdocs to v5



* **Tag `2020-05-31_1`** (legacy): `https://gitlab.com/go2scale/hub/-/raw/2020-05-05_3/jobs/documentation.gitlab-ci.yml`



    * Initial version

docs/Jobs/pages/README.md

+3 −3
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ from previous job named `documentation`. 


    ```yaml

    include:

      - remote: 'https://gitlab.com/go2scale/hub/-/raw/latest/Jobs/pages/pages.yml'

      - remote: 'https://jobs.go2scale.io/pages'

    ```



3. If you need set variables in jobs, use `variables` option in
@@ -42,8 +42,8 @@ from previous job named `documentation`. 


## Versions



* **Latest** : `https://gitlab.com/go2scale/jobs/-/raw/latest/Jobs/mkdocs/mkdocs.yml`

* **Tag `2020-05-31_1`** : `https://gitlab.com/go2scale/jobs/-/raw/2020-05-31_1/Jobs/mkdocs/mkdocs.yml`

* **Latest** : `https://jobs.go2scale.io/pages/latest`

* **Tag `2020-05-31_1`** : `https://jobs.go2scale.io/pages/2020-05-31_1`



    !!! warning

        This update introduces breaking changes. Follow [this

docs/getting-started.md

+6 −6
Original line number Diff line number Diff line
@@ -54,7 +54,8 @@ configuration file. 


An example of a full `.gitlab-ci.yml` file with:



* One job template with latest version (`master`)

* One job template with latest version. Note that `/latest` is optional in the

  job URL

* One job template with specific version using tag `2020-06-22_1`

* Configuration for one job using `variables`

* A custom `unit_tests` job
@@ -63,15 +64,14 @@ An example of a full `.gitlab-ci.yml` file with: 
stages:

  - static_tests

  - build

  - review

  - dynamic_tests

  - staging

  - production

  - review

  - deployment



# Jobs from g2s hub

include:

  - remote: 'https://gitlab.com/go2scale/jobs/-/raw/master/Jobs/docker/docker.yml'

  - remote: 'https://gitlab.com/go2scale/jobs/-/raw/2020-06-22_1/Jobs/mkdocs/mkdocs.yml'

  - remote: 'https://jobs.go2scale.io/docker/latest'

  - remote: 'https://jobs.go2scale.io/mkdocs/2020-06-22_1'



# Some jobs can be configured with variables

variables:

docs/versioning.md

+5 −5
Original line number Diff line number Diff line
@@ -5,8 +5,9 @@ Jobs are versioned using git tag following this format: `YYYY-MM-DD_RELEASE`. 
!!! note

    `RELEASE` is a number started from 1



You can also use the latest version using `master` instead of a tag. Using

this, you will retrieve the latest version of jobs at each run.

You can also use the latest version using `latest` instead of a tag. Using

this, you will retrieve the latest version of jobs at each run. Note that if

you don't set any tag, `latest` is used by default.





Each jobs can be used independently with different version date.
@@ -15,9 +16,8 @@ Example in `.gitlab-ci.yml`: 


```yaml

include:

  - remote: https://gitlab.com/go2scale/jobs/-/raw/2020-02-28_1/Jobs/coala/coala.yml

  - remote: https://gitlab.com/go2scale/jobs/-/raw/2020-03-05_1/Jobs/mkdocs/mkdocs.yml

  - remote: https://gitlab.com/go2scale/jobs/-/raw/master/Jobs/helm/helm.yml

  - remote: 'https://jobs.go2scale.io/docker/latest'

  - remote: 'https://jobs.go2scale.io/mkdocs/2020-06-22_1'

```



Available tags and release note for each jobs are available in [Jobs