Skip to content

Commit

Permalink
Simplify single event trigger in README (#782)
Browse files Browse the repository at this point in the history 
* docs: simplify single event trigger in README

and DEVELOPMENT.md

* Change also for auto cancel
  • Loading branch information
@MikeMcC399
MikeMcC399 committed Mar 2, 2023
1 parent 4160b9d commit 9e53751
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 35 deletions.
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

```yml
name: End-to-end tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: 22.04
Expand Down
66 changes: 32 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [Explicit version](#explicit-version)
- Run tests in a given [browser](#browser)
- using [Firefox](#firefox)
- using [Edge](#edge)
- using [Edge](#edge)
- using [headed mode](#headed)
- Using [Docker image](#docker-image)
- Specify [environment variables](#env)
Expand Down Expand Up @@ -47,7 +47,7 @@

```yml
name: End-to-end tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -92,7 +92,7 @@ Specify the browser name or path with `browser` parameter

```yml
name: E2E on Chrome
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -154,7 +154,7 @@ Run the browser in headed mode - as of Cypress v8.0 the `cypress run` command ex

```yml
name: Chrome headed
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -172,7 +172,7 @@ You can run tests in a GH Action in your Docker container.

```yml
name: E2E in custom container
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -192,7 +192,7 @@ Specify the env argument with `env` parameter

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -210,7 +210,7 @@ When passing the environment variables this way, unfortunately due to GitHub Act

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -235,7 +235,7 @@ Specify the [spec files to run](https://docs.cypress.io/guides/guides/command-li

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand Down Expand Up @@ -266,7 +266,7 @@ Specify the [project to run](https://docs.cypress.io/guides/guides/command-line.

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand All @@ -286,7 +286,7 @@ For more information, visit [the Cypress command-line docs](https://on.cypress.i

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand Down Expand Up @@ -318,7 +318,7 @@ jobs:

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand Down Expand Up @@ -346,7 +346,7 @@ You can provide `quiet` flag for cypress run to silence any Cypress specific out

```yml
name: example-quiet
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -370,7 +370,7 @@ You can pass a single or multiple tags when recording a run. For example

```yml
name: tags
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -413,7 +413,7 @@ This feature requires Cypress 12.6.0 or later and a [Cypress Cloud Business or E

```yml
name: Cypress E2E Tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -444,7 +444,7 @@ If you don't record the test run on Cypress Cloud, you can still store generated

```yml
name: Artifacts
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -477,7 +477,7 @@ Specify [configuration](https://docs.cypress.io/guides/references/configuration.

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand All @@ -500,7 +500,7 @@ Specify the path to your config file with `config-file` parameter

```yml
name: Cypress tests
on: [push]
on: push
jobs:
cypress-run:
name: Cypress run
Expand All @@ -523,9 +523,7 @@ You can spin multiple containers running in parallel using `strategy: matrix` ar

```yml
name: Parallel Cypress Tests

on: [push]

on: push
jobs:
test:
name: Cypress run
Expand Down Expand Up @@ -590,7 +588,7 @@ You can run a build step before starting tests

```yml
name: Build
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -609,7 +607,7 @@ If your tests run against a local server, use `start` parameter, the server will

```yml
name: With server
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -626,7 +624,7 @@ jobs:

```yml
name: With server
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -652,7 +650,7 @@ You can start multiple server processes. For example, if you have an API to star

```yml
name: With servers
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -682,7 +680,7 @@ If you are starting a local server and it takes a while to start, you can add a

```yml
name: After server responds
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -757,7 +755,7 @@ You can prefix the default test command using the `command-prefix` option. This

```yml
name: Visual
on: [push]
on: push
jobs:
e2e:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -798,7 +796,7 @@ You can overwrite [`ci-build-id`](https://on.cypress.io/parallelization#Linking-

```yml
name: Parallel
on: [push]
on: push
jobs:
test:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -905,7 +903,7 @@ repo/
You can specify the `app-test` working directory when running Cypress tests using the `working-directory` parameter

```yml
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -968,7 +966,7 @@ This action should discover the Yarn workspaces correctly. For example, see fold

```yaml
name: example-start-and-yarn-workspaces
on: [push]
on: push
jobs:
single:
# the example has Yarn workspace in its "root" folder
Expand All @@ -993,7 +991,7 @@ Sometimes the default cache key does not work. For example, if you cannot share

```yml
name: End-to-end tests
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -1028,7 +1026,7 @@ You can run your tests across multiple Node versions.

```yml
name: Node versions
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -1257,7 +1255,7 @@ If your repository does not have `package.json` or `yarn.json` (maybe it contain

```yml
name: included
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -1277,7 +1275,7 @@ If you are NOT using the `build` command in your project, you can run the `cypre

```yml
name: info
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand All @@ -1294,7 +1292,7 @@ If you are already using the `build` parameter, you can split the [installation

```yml
name: info
on: [push]
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
Expand Down

0 comments on commit 9e53751

Please sign in to comment.