Commit 106fbe35 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: update GitLab links

parent 031a617e

.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

+4 −4
Original line number Diff line number Diff line
@@ -4,8 +4,8 @@ This project implements a GitLab CI/CD template to run your automated tests with 


## 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
@@ -58,7 +58,7 @@ In addition to a textual report in the console, this job produces the following 


| Report                                                 | Format                                                                      | Usage                                                                                                 |

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

| `$PLAYWRIGHT_PROJECT_DIR/reports/playwright.xunit.xml` | [xUnit](https://github.com/jest-community/jest-junit#readme) test report(s) | [GitLab integration](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsjunit) |

| `$PLAYWRIGHT_PROJECT_DIR/reports/playwright.xunit.xml` | [xUnit](https://github.com/jest-community/jest-junit#readme) test report(s) | [GitLab integration](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsjunit) |



### base url auto evaluation
@@ -68,7 +68,7 @@ By default, the Playwright template tries to auto-determine the [baseURL](https: 
When found, the base url is passed as `$BASE_URL` environment variable and can be reused in your Playwright tests (see below).



Therefore if an upstream job in the pipeline deployed your code to a server and propagated the deployed server url,

either through a [dotenv](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv) variable `$environment_url`

either through a [dotenv](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv) variable `$environment_url`

or through a basic `environment_url.txt` file, then the Playwright test will automatically be run on this server.



:warning: all our deployment templates implement this design. Therefore even purely dynamic environments (such as review

templates/gitlab-ci-playwright.yml

+1 −1
Original line number Diff line number Diff line
@@ -419,7 +419,7 @@ playwright: 
    paths:

      - $PLAYWRIGHT_PROJECT_DIR/reports/playwright.*

    reports:

      # use JUnit format and GitLab integration (see: https://docs.gitlab.com/ee/ci/yaml/#artifactsreports)

      # use JUnit format and GitLab integration (see: https://docs.gitlab.com/ci/yaml/#artifactsreports)

      junit:

        - $PLAYWRIGHT_PROJECT_DIR/reports/playwright.xunit.xml

    expire_in: 1 day