Commit f743f7f0 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: update GitLab links

parent d1b6f074

.gitlab/merge_request_templates/initial.md

+11 −11
Original line number Diff line number Diff line
@@ -12,8 +12,8 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 
* General:

    * [ ] add project logo (`logo.png` file) - preferably 256x256

    * [ ] defines a base (hidden) job

    * [ ] use [rules](https://docs.gitlab.com/ee/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ee/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration (wherever applicable)

    * [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)

* Publicly usable:

    * [ ] runners: untagged

    * [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy` configuration
@@ -38,9 +38,9 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 
* Build & Test job:

    * (type here the used build & test tools/frameworks)

    * [ ] mapped to the `build` stage

    * [ ] unit tests report integration using [JUnit test report](https://docs.gitlab.com/ee/ci/junit_test_reports.html)

    * [ ] code coverage computing and [integration](https://docs.gitlab.com/ee/ci/yaml/#coverage)

    * [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration

    * [ ] unit tests report integration using [JUnit test report](https://docs.gitlab.com/ci/testing/unit_test_reports/)

    * [ ] code coverage computing and [integration](https://docs.gitlab.com/ci/yaml/#coverage)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration

* (optional) Code analysis job(s):

    * (type here the used code analysis tools)

    * [ ] mapped to the `test` stage
@@ -59,7 +59,7 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 
    * [ ] mapped to the `test` stage

    * [ ] can be enabled/disabled by configuration

    * [ ] whenever possible, code analysis on non-`master`, non-`develop` branches should be a partial/light analysis

    * [ ] if the analysis is time consuming it shall be [triggered manually](https://docs.gitlab.com/ee/ci/yaml/#whenmanual)

    * [ ] if the analysis is time consuming it shall be [triggered manually](https://docs.gitlab.com/ci/yaml/#whenmanual)

      by default, and automatable by configuration



### Packaging template checklist
@@ -79,14 +79,14 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 
* Deployment jobs:

    * [ ] one hidden deploy job prototype

    * [ ] persist and propagate the `$CI_ENVIRONMENT_URL` variable as `environment_url` variable using a 

      [dotenv artifact](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportsdotenv)

      [dotenv artifact](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv)

    * [ ] each env can be enabled/disabled by configuration

    * [ ] each env uses the [`resource_group`](https://docs.gitlab.com/ee/ci/yaml/#resource_group) feature to prevent 

    * [ ] each env uses the [`resource_group`](https://docs.gitlab.com/ci/yaml/#resource_group) feature to prevent 

      multiple pipelines from deploying to the same environment at the same time

    * [ ] **review** deployment job

        * mapped to the `deploy` stage

        * must be executed on non-`master`, non-`develop` branches only

        * must reference the **cleanup-review** job (see below) in its [`environment:on_stop`](https://docs.gitlab.com/ee/ci/yaml/#environmenton_stop)

        * must reference the **cleanup-review** job (see below) in its [`environment:on_stop`](https://docs.gitlab.com/ci/yaml/#environmenton_stop)

    * [ ] **integration** deployment job

        * mapped to the `deploy` stage

        * must be executed on `develop` branch only
@@ -101,7 +101,7 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 
    * [ ] **review** cleanup job

        * mapped to the `deploy` stage

        * must be executed on non-`master`, non-`develop` branches only

        * must be associated to the [`environment:action:stop`](https://docs.gitlab.com/ee/ci/yaml/#environmentaction) event

        * must be associated to the [`environment:action:stop`](https://docs.gitlab.com/ci/yaml/#environmentaction) event

* (optional) Analysis job(s) (linters, dependency checks, ...) depending on the technologies:

    * [ ] mapped to the `test` stage
@@ -111,7 +111,7 @@ Template type: **build** / **analyse** / **package** / **deploy** / **acceptance 


* Acceptance test job:

    * [ ] mapped to the `acceptance` stage

    * [ ] tests report integration using [JUnit test report](https://docs.gitlab.com/ee/ci/junit_test_reports.html)

    * [ ] tests report integration using [JUnit test report](https://docs.gitlab.com/ci/testing/unit_test_reports/)

    * [ ] auto-evaluating the environment url to test based on the possible upstream `$environment_url` variable or via 

      an `environment_url.txt` file.

.gitlab/merge_request_templates/new_feature.md

+2 −2
Original line number Diff line number Diff line
@@ -8,8 +8,8 @@ Closes #999 
## Checklist



* General:

    * [ ] use [rules](https://docs.gitlab.com/ee/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ee/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration (wherever applicable)

    * [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)

* Publicly usable:

    * [ ] untagged runners

    * [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy`

CONTRIBUTING.md

+1 −1
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ To contribute: 


1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).

2. Make sure the issue has been reviewed and agreed.

3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) documentation).

3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.gitlab.com/user/project/repository/forking_workflow/) documentation).

   Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.



### Git Commit Conventions

README.md

+9 −9
Original line number Diff line number Diff line
@@ -5,8 +5,8 @@ images that can run on any cloud with [Cloud Native Buildpacks](https://buildpac 


## Usage



This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ci/components/#use-a-component) 

or using the legacy [`include:project`](https://docs.gitlab.com/ci/yaml/#includeproject) syntax.



### Use as a CI/CD component
@@ -130,12 +130,12 @@ If you use **different registries** for snapshot and release images, you shall u 


Here are some advices about your **secrets** (variables marked with a :lock:):



1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project):

    * [**masked**](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable) to prevent them from being inadvertently

1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ci/variables/#for-a-project):

    * [**masked**](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable) to prevent them from being inadvertently

      displayed in your job logs,

    * [**protected**](https://docs.gitlab.com/ee/ci/variables/#protected-cicd-variables) if you want to secure some secrets

    * [**protected**](https://docs.gitlab.com/ci/variables/#protected-cicd-variables) if you want to secure some secrets

      you don't want everyone in the project to have access to (for instance production secrets).

2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable),

2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable),

  simply define its value as the [Base64](https://en.wikipedia.org/wiki/Base64) encoded value prefixed with `@b64@`:

  it will then be possible to mask it and the template will automatically decode it prior to using it.

3. Don't forget to escape special characters (ex: `$` -> `$$`).
@@ -172,7 +172,7 @@ If you're using Packeto Builder and Buildpacks (default), you shall use: 
If you selected an alternate Builder and Buildpacks (by overriding the `CNB_BUILDER_IMAGE` variable), then refer to the related documentation.

-->



This job produces _output variables_ that are propagated to downstream jobs (using [dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv)):

This job produces _output variables_ that are propagated to downstream jobs (using [dotenv artifacts](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv)):



| Input / Variable | Description                                            | Example                                 |

| ------------------ | ------------------------------------------------------ | --------------------------------------- |
@@ -231,7 +231,7 @@ In addition to a textual report in the console, this job produces the following 
| Report                            | Format                                                                       | Usage             |

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

| `reports/cnb-trivy-*.native.json` | native Trivy report format (json) | [DefectDojo integration](https://docs.defectdojo.com/en/connecting_your_tools/parsers/file/trivy/)<br/>_This report is generated only if DefectDojo template is detected_ |

| `reports/cnb-trivy-*.gitlab.json` | [Trivy report format for GitLab](https://aquasecurity.github.io/trivy/latest/tutorials/integrations/gitlab-ci/) format | [GitLab integration](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscontainer_scanning) |

| `reports/cnb-trivy-*.gitlab.json` | [Trivy report format for GitLab](https://aquasecurity.github.io/trivy/latest/tutorials/integrations/gitlab-ci/) format | [GitLab integration](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportscontainer_scanning) |



### `cnb-publish` job
@@ -243,7 +243,7 @@ This job pushes (_promotes_) the built image as the _release_ image using [skope 
| `publish-args` / `CNB_PUBLISH_ARGS` | Additional [`skopeo copy` arguments](https://github.com/containers/skopeo/blob/master/docs/skopeo-copy.1.md#options) | _(none)_          |

| `prod-publish-strategy` / `CNB_PROD_PUBLISH_STRATEGY` | Defines the publish to production strategy. One of `manual` (i.e. _one-click_), `auto` or `none` (disabled). | `manual` |



This job produces _output variables_ that are propagated to downstream jobs (using [dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv)):

This job produces _output variables_ that are propagated to downstream jobs (using [dotenv artifacts](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv)):



| Input / Variable | Description                                           | Example                                 |

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