Skip to content

Commit cc4464b

Browse files
authored
docs: active support v10 and later (#1276)
* docs: active support v10 and later * use term "above"
1 parent 2bccd4a commit cc4464b

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The repository is set up with a `git` / `Husky` pre-commit hook which ensures th
6666

6767
### Adding a new example
6868

69-
1. If you are creating a new example, add this as a new project in the `examples` directory. An example project is a regular npm package with its own `package.json` and Cypress dev dependency. (Note: Legacy `examples/v9` are archived in the [v5](https://github.com/cypress-io/github-action/tree/v5/) branch. It is not expected to create any new `v9` examples.)
69+
1. If you are creating a new example, add this as a new project in the `examples` directory. An example project is a regular npm package with its own `package.json` and Cypress dev dependency. (Note: Legacy `examples/v9` are archived in the [v5](https://github.com/cypress-io/github-action/tree/v5/) branch and are no longer supported or maintained.)
7070
1. Add a corresponding `.github/workflows` YAML file that uses this action and runs using your new `examples/X` through the `working-directory` parameter. The example should demonstrate any new feature.
7171
1. Add a workflow status badge to the [README.md](README.md) file (see [Adding a workflow status badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)), like the following:
7272

README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,12 @@
6363
- Suppress [job summary](#suppress-job-summary)
6464
- [More examples](#more-examples)
6565

66-
Examples contained in this repository, based on current Cypress versions, can be found in the [examples](./examples) directory. Examples for [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration), which use Cypress `9.7.0`, are no longer maintained. They can be referred to in the [examples/v9](https://github.com/cypress-io/github-action/tree/v5/examples/v9) directory of the [v5](https://github.com/cypress-io/github-action/tree/v5/) branch.
66+
Examples contained in this repository, based on current Cypress versions, can be found in the [examples](./examples) directory.
6767

6868
Live examples, such as [example-basic.yml](.github/workflows/example-basic.yml) are shown together with a status badge. Click on the status badge to read the source code of the workflow, for example
6969

7070
[![End-to-End example](https://github.com/cypress-io/github-action/actions/workflows/example-basic.yml/badge.svg)](.github/workflows/example-basic.yml)
7171

72-
Older **external** examples based on a [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration) for Cypress `9` and earlier can be found in the [README](https://github.com/cypress-io/github-action/blob/v5/README.md) for version `v5`.
73-
7472
**Note:** this package assumes that [cypress](https://www.npmjs.com/package/cypress) is declared as a development dependency in the [package.json](https://docs.npmjs.com/creating-a-package-json-file) file. The [cypress npm module](https://www.npmjs.com/package/cypress) is required to run Cypress via its [Module API](https://on.cypress.io/module-api).
7573

7674
### End-to-End Testing
@@ -1675,7 +1673,7 @@ View the [CHANGELOG](./CHANGELOG.md) document for an overview of version changes
16751673

16761674
## Compatibility
16771675

1678-
- `github-action@v6` is the current recommended version and uses `node20`
1676+
- `github-action@v6` is the current recommended version, uses `node20` and is compatible with Cypress `10` and above.
16791677
- `github-action` versions `v1` to `v5` are unsupported: they rely on Node.js `12` and `16` in End-of-life status.
16801678

16811679
## Contributing

docs/MAINTENANCE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The [examples](../examples) directory contains examples of the use of Cypress (C
88

99
The examples make use of [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [Yarn 1 (Classic)](https://classic.yarnpkg.com/) and [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) to define and install the packages being used.
1010

11-
*The previous [examples/v9](https://github.com/cypress-io/github-action/tree/v5/examples/v9) are archived in the [v5](https://github.com/cypress-io/github-action/tree/v5/) branch. This directory contains examples which were set up to use Cypress `9.7.0`, the last version using [Legacy Configuration](https://docs.cypress.io/guides/references/legacy-configuration), covering Cypress 9 and below. These `v9` examples are no longer maintained.
11+
*The previous [examples/v9](https://github.com/cypress-io/github-action/tree/v5/examples/v9) are archived in the [v5](https://github.com/cypress-io/github-action/tree/v5/) branch. This directory contains examples which were set up to use Cypress `9.7.0`, the last version using Legacy Configuration, covering Cypress 9 and below. These `v9` examples are no longer maintained.
1212

1313
## Requirements
1414

0 commit comments

Comments
 (0)