Skip to content

Commit 0fbf9b5

Browse files
authored
docs: remove legacy v9 references (cypress-io#1481)
1 parent 5adfa49 commit 0fbf9b5

4 files changed

Lines changed: 3 additions & 5 deletions

File tree

.github/workflows/example-custom-ci-build-id.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
env:
2626
# Set up the Cypress Cloud project ID and record key as environment variables
2727
# If the Actions secret EXAMPLE_PROJECT_ID is not defined then
28-
# the projectId is taken from cypress.json (v9) or cypress.config.js (v10 and later).
28+
# the projectId is taken from cypress.config.js.
2929
# If the Actions secret EXAMPLE_RECORDING_KEY is not defined then recording jobs are skipped.
3030
CYPRESS_PROJECT_ID: ${{ secrets.EXAMPLE_PROJECT_ID }}
3131
CYPRESS_RECORD_KEY: ${{ secrets.EXAMPLE_RECORDING_KEY }}

.github/workflows/example-recording.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
env:
1414
# Set up the Cypress Cloud project ID and record key as environment variables
1515
# If the Actions secret EXAMPLE_PROJECT_ID is not defined then
16-
# the projectId is taken from cypress.json (v9) or cypress.config.js (v10 and later).
16+
# the projectId is taken from cypress.config.js.
1717
# If the Actions secret EXAMPLE_RECORDING_KEY is not defined then recording jobs are skipped.
1818
CYPRESS_PROJECT_ID: ${{ secrets.EXAMPLE_PROJECT_ID }}
1919
CYPRESS_RECORD_KEY: ${{ secrets.EXAMPLE_RECORDING_KEY }}

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The repository is set up with a `git` / `Husky` pre-commit hook which ensures th
7979

8080
### Adding a new example
8181

82-
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.)
82+
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.
8383
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.
8484
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:
8585

docs/MAINTENANCE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ 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/) to define and install the packages being used. For [Yarn Modern](https://yarnpkg.com/) the recommended [Corepack](https://yarnpkg.com/corepack) is used as a Yarn version manager.
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, covering Cypress 9 and below. These `v9` examples are no longer maintained._
12-
1311
## Requirements
1412

1513
- A local system running [Ubuntu](https://ubuntu.com/), <!-- markdown-link-check-disable -->[Microsoft Windows](https://www.microsoft.com/windows/)<!-- markdown-link-check-enable --> or [Apple macOS](https://www.apple.com/macos/).

0 commit comments

Comments
 (0)