|
| 1 | +# https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions |
| 2 | +name: "Cypress.io" |
| 3 | +description: "GitHub Action for running Cypress end-to-end and component tests" |
| 4 | +author: "Cypress-io" |
| 5 | +inputs: |
| 6 | + # inputs passed to Cypress Module API https://on.cypress.io/module-api |
| 7 | + # Action options names are the same as Cypress Module API options names, except where noted |
| 8 | + # and Cypress CLI option names https://on.cypress.io/command-line#Options are used instead |
| 9 | + auto-cancel-after-failures: |
| 10 | + description: "Overrides the global Cloud configuration to set the failed test threshold for auto cancellation or to disable auto cancellation when recording to the Cloud (requires Cypress 12.x or later)" |
| 11 | + required: false |
| 12 | + browser: |
| 13 | + description: "Name of the browser to use" |
| 14 | + required: false |
| 15 | + ci-build-id: |
| 16 | + description: "ID associates multiple CI machines to one test run" |
| 17 | + required: false |
| 18 | + component: # translates to Module API testingType e2e (default / false) or component (true) |
| 19 | + description: "Lets the action know that Cypress is running component tests and not e2e tests" |
| 20 | + required: false |
| 21 | + default: false |
| 22 | + config: |
| 23 | + description: "Set configuration values. Separate multiple values with a comma. The values set here override any values set in your configuration file." |
| 24 | + required: false |
| 25 | + config-file: |
| 26 | + description: "Path to the cypress config file where configuration values are set" |
| 27 | + required: false |
| 28 | + default: "" |
| 29 | + env: |
| 30 | + description: "Sets Cypress environment variables" |
| 31 | + required: false |
| 32 | + group: |
| 33 | + description: "Group setting for recording tests" |
| 34 | + required: false |
| 35 | + headed: |
| 36 | + description: "Whether or not to use headed mode" |
| 37 | + required: false |
| 38 | + # headless: # not used (default and equivalent to headed: false) |
| 39 | + # key: # not used. Pass this option using CYPRESS_RECORD_KEY as a secret environment variable |
| 40 | + # exit: # not used |
| 41 | + parallel: |
| 42 | + description: "Whether or not to load balance recorded tests using multiple containers" |
| 43 | + required: false |
| 44 | + # port: # not used |
| 45 | + project: |
| 46 | + description: "Path of project to run" |
| 47 | + required: false |
| 48 | + quiet: |
| 49 | + description: "Whether or not to silence any Cypress specific output from stdout" |
| 50 | + required: false |
| 51 | + record: |
| 52 | + description: "Sends test results to Cypress Cloud" |
| 53 | + required: false |
| 54 | + default: false |
| 55 | + # reporter: # not used |
| 56 | + # reporterOptions: # not used |
| 57 | + # runnerUi: # not used |
| 58 | + # slowTestThreshold # not used |
| 59 | + spec: |
| 60 | + description: "Provide specific specs to run" |
| 61 | + required: false |
| 62 | + tag: |
| 63 | + description: "Tag setting for tests" |
| 64 | + required: false |
| 65 | + # |
| 66 | + # inputs used internally by action, not passed to Cypress Module API |
| 67 | + # |
| 68 | + build: |
| 69 | + description: "Command to run build step before starting tests" |
| 70 | + required: false |
| 71 | + cache-key: |
| 72 | + description: "Custom cache key" |
| 73 | + required: false |
| 74 | + command: # Using this option overrides passing inputs to the Cypress Module API |
| 75 | + description: "Command that overrides cypress run" |
| 76 | + required: false |
| 77 | + command-prefix: |
| 78 | + description: "You can prefix the default test command using the command-prefix option." |
| 79 | + required: false |
| 80 | + install: |
| 81 | + description: "Whether or not to run install" |
| 82 | + required: false |
| 83 | + install-command: |
| 84 | + description: "Custom install command to use" |
| 85 | + required: false |
| 86 | + publish-summary: |
| 87 | + description: "Whether or not to publish a job summary" |
| 88 | + required: false |
| 89 | + default: true |
| 90 | + runTests: |
| 91 | + description: "Whether or not to run tests" |
| 92 | + required: false |
| 93 | + start: |
| 94 | + description: "Command for starting local server in the background" |
| 95 | + required: false |
| 96 | + start-windows: |
| 97 | + description: "A different start command on Windows" |
| 98 | + required: false |
| 99 | + summary-title: |
| 100 | + description: "Title for job summary" |
| 101 | + required: false |
| 102 | + wait-on: |
| 103 | + description: "Local server URL to wait for" |
| 104 | + required: false |
| 105 | + wait-on-timeout: |
| 106 | + description: "Amount of time to wait for wait-on URL to be available" |
| 107 | + required: false |
| 108 | + working-directory: |
| 109 | + description: "Working directory containing Cypress folder" |
| 110 | + required: false |
| 111 | +outputs: |
| 112 | + # derived from Cypress Module API https://on.cypress.io/module-api#Results runUrl |
| 113 | + dashboardUrl: |
| 114 | + description: "Cypress Cloud URL if the run was recorded (deprecated)" |
| 115 | + resultsUrl: |
| 116 | + description: "Cypress Cloud URL if the run was recorded" |
| 117 | +runs: |
| 118 | + using: "node20" |
| 119 | + main: "dist/index.js" |
| 120 | +branding: |
| 121 | + color: "green" |
| 122 | + icon: "check-square" |
0 commit comments