Commit a47dc66c authored by Cédric OLIVIER's avatar Cédric OLIVIER
Browse files

Merge branch 'feat/component' into 'main' 

feat: migrate to CI/CD component

See merge request to-be-continuous/playwright!3
parents 7af5d3e8 374514f0

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ include: 
    file: '/templates/validation.yml'

  - project: 'to-be-continuous/bash'

    ref: '3.3'

    file: 'templates/gitlab-ci-bash.yml'

    file: '/templates/gitlab-ci-bash.yml'

  - project: 'to-be-continuous/semantic-release'

    ref: '3.7'

    file: '/templates/gitlab-ci-semrel.yml'

README.md

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


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

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

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



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/playwright/gitlab-ci-playwright@1.1.0

    # 2: set/override component inputs

    inputs:

      # ⚠ this is only an example

      project-dir: "e2e"

      review-enabled: "true"

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/playwright'

    ref: '1.1.0'

    file: '/templates/gitlab-ci-playwright.yml'



variables:

  # 2: set/override template variables

  # ⚠ this is only an example

  PLAYWRIGHT_PROJECT_DIR: "e2e"

  REVIEW_ENABLED: "true"

```



## `playwright` job
@@ -19,12 +46,12 @@ This job starts [Playwright](https://playwright.dev/docs/intro) (functional) tes 


It uses the following variable:



| Name                     | Description                                                                                                                 | Default value                               |

| Input / Variable | Description                                                                                                                 | Default value                               |

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

| `PLAYWRIGHT_IMAGE`       | The Docker image used to run Playwright.                                                                                    | `mcr.microsoft.com/playwright:latest` |

| `PLAYWRIGHT_PROJECT_DIR` | The Playwright root project directory (contains the `playwright.config.ts` file)                                            | `.`                                         |

| `PLAYWRIGHT_EXTRA_ARGS`  | Playwright extra [run options](https://playwright.dev/docs/test-cli)                                                        | _none_                                      |

| `REVIEW_ENABLED`         | Set to `true` to enable Playwright tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled)                           |

| `image` / `PLAYWRIGHT_IMAGE` | The Docker image used to run Playwright.                                                                                    | `mcr.microsoft.com/playwright:latest` |

| `project-dir` / `PLAYWRIGHT_PROJECT_DIR` | The Playwright root project directory (contains the `playwright.config.ts` file)                                            | `.`                                         |

| `extra-args` / `PLAYWRIGHT_EXTRA_ARGS` | Playwright extra [run options](https://playwright.dev/docs/test-cli)                                                        | _none_                                      |

| `review-enabled` / `REVIEW_ENABLED` | Set to `true` to enable Playwright tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled)                           |



In addition to a textual report in the console, this job produces the following reports, kept for one day:

bumpversion.sh

+2 −2
Original line number Diff line number Diff line
@@ -27,13 +27,13 @@ if [[ "$curVer" ]]; then 
  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."



  # replace in README

  sed -e "s/ref: '$curVer'/ref: '$nextVer'/" README.md > README.md.next

  sed -e "s/ref: *'$curVer'/ref: '$nextVer'/" -e "s/ref: *\"$curVer\”/ref: \”$nextVer\”/" -e "s/component: *\(.*\)@$curVer/component: \1@$nextVer/" README.md > README.md.next

  mv -f README.md.next README.md



  # replace in template and variants

  for tmpl in templates/*.yml

  do

    sed -e "s/\"$curVer\"/\"$nextVer\"/" "$tmpl" > "$tmpl.next"

    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"

    mv -f "$tmpl.next" "$tmpl"

  done

else

kicker.json

+2 −0
Original line number Diff line number Diff line
@@ -4,6 +4,8 @@ 
  "description": "Run your automated tests with [Playwright](https://playwright.dev/docs/intro)",

  "template_path": "templates/gitlab-ci-playwright.yml",

  "kind": "acceptance",

  "prefix": "playwright",

  "is_component": true,

  "variables": [

    {

      "name": "PLAYWRIGHT_IMAGE",

logo.png

+3.76 KiB (17.6 KiB)
Loading image diff...