github-action/action.yml at main · PrestaFlow/github-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
name: "PrestaFlow"
description: "Run PrestaFlow tests in CI: optional PrestaShop setup via Flashlight, upload results, comment PRs."
author: "PrestaFlow"

inputs:
  token:
    description: "PrestaFlow API token (repository secret)."
    required: true
  projectId:
    description: "PrestaFlow project Product Key (e.g. pk_01ABC...). Must match the project the token was issued for."
    required: false
  execute:
    description: "Run composer run prestaflow:json:file before upload."
    required: false
    default: 'true'
  suites:
    description: "Comma-separated list of suites to run (e.g. BackOffice,FrontOffice). Empty runs all suites."
    required: false
    default: ''
  flashlight:
    description: "Start a PrestaShop Flashlight Docker instance for the tests to target. A temporary .env.local is written for the run (Flashlight URLs, PS version and back-office credentials, merged with your .env/.env.local and any PRESTAFLOW_* set with env: on the step); an existing .env.local is restored afterwards."
    required: false
    default: 'false'
  ps-version:
    description: "Flashlight image tag (e.g. 9.0.0, 8.1.7, latest). Ignored when flashlight is false."
    required: false
    default: 'latest'
  flashlight-mount:
    description: "Where to mount the workspace inside the Flashlight container. 'auto' (default) picks modules/themes based on composer.json type, or falls back to modules/<repo>. 'root' mounts the workspace at /var/www/html (custom PrestaShop). 'modules' and 'themes' force those locations."
    required: false
    default: 'auto'
  flashlight-init-scripts:
    description: "Optional path (absolute or relative to the workspace) to a directory of Flashlight init scripts. Mounted read-only at /tmp/init-scripts. Scripts must be executable and start with a shebang; they run alphabetically at container boot."
    required: false
    default: ''
  flashlight-install-module:
    description: "When the workspace is a composer prestashop-module mounted in Flashlight, run 'php bin/console prestashop:module install <name>' in the container once the shop is ready. Harmless if an init-script already installed it (PrestaShop upgrades it instead). A failed install only emits a warning. Set to 'false' to skip."
    required: false
    default: 'true'
  pr-comment:
    description: "Post/update a summary comment on the pull request (one comment per projectId and, with Flashlight, per ps-version). Defaults to true on pull_request events, false otherwise."
    required: false
    default: ''
  github-token:
    description: "Token used to post the PR comment."
    required: false
    default: ${{ github.token }}
  upload-artifacts:
    description: "Upload results.json + error screenshots as a GitHub artifact named prestaflow-report-<run>-<attempt>-<job>[-ps<ps-version>][-<suites>] (unique per matrix leg; a random suffix is added if the name is still taken)."
    required: false
    default: 'true'
  visual:
    description: "Enable visual regression round-trip with the API (download baselines before run, upload actual/diff after)."
    required: false
    default: 'true'

outputs:
  id:
    description: "PrestaFlow report ID."
  report-url:
    description: "URL of the report on prestaflow.io."
  passed:
    description: "Number of passing tests."
  failed:
    description: "Number of failing tests."
  skipped:
    description: "Number of skipped tests."
  total:
    description: "Total number of tests."
  duration-ms:
    description: "Total execution duration in milliseconds."
  status:
    description: "'success' if failed==0, else 'failure'."

runs:
  using: "node20"
  main: "dist/index.js"

branding:
  icon: 'layers'
  color: 'blue'