Skip to content

Commit fd50b62

Browse files
authoredSep 1, 2023
feat: recommend v6 as standard action version (#1014)
1 parent 4199fba commit fd50b62

6 files changed

+71
-71
lines changed
 

‎.github/workflows/example-basic-pnpm.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121

2222
- name: Cypress tests
2323
# normally you would write
24-
# uses: cypress-io/github-action@v5
24+
# uses: cypress-io/github-action@v6
2525
uses: ./
2626
# the parameters below are only necessary
2727
# because we are running these examples in a monorepo

‎.github/workflows/example-basic.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717

1818
- name: Cypress tests
1919
# normally you would write
20-
# uses: cypress-io/github-action@v5
20+
# uses: cypress-io/github-action@v6
2121
uses: ./
2222
# the parameters below are only necessary
2323
# because we are running these examples in a monorepo

‎.github/workflows/example-component-test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
uses: actions/checkout@v3
1515
- name: Cypress run
1616
# normally you would write
17-
# uses: cypress-io/github-action@v5
17+
# uses: cypress-io/github-action@v6
1818
uses: ./
1919
with:
2020
working-directory: examples/component-tests

‎.github/workflows/example-recording.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050

5151
- name: Cypress tests
5252
# normally you would write
53-
# uses: cypress-io/github-action@v5
53+
# uses: cypress-io/github-action@v6
5454
uses: ./
5555
# let's give this action an ID so we can refer
5656
# to its output values later
@@ -83,7 +83,7 @@ jobs:
8383

8484
- name: Cypress tests
8585
# normally you would write
86-
# uses: cypress-io/github-action@v5
86+
# uses: cypress-io/github-action@v6
8787
uses: ./
8888
with:
8989
working-directory: examples/recording

‎CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ which calls the action code from the branch they are running in when the workflo
8383
From another (external) repository, the production version of the action is called with
8484

8585
```yaml
86-
- uses: cypress-io/github-action@v5
86+
- uses: cypress-io/github-action@v6
8787
```
8888

89-
To test out a branch in development calling it from another repository, replace `v5` by the name of your branch. If your branch is in a fork, then also replace `cypress-io` by your own GitHub username in the form:
89+
To test out a branch in development calling it from another repository, replace `v6` by the name of your branch. If your branch is in a fork, then also replace `cypress-io` by your own GitHub username in the form:
9090

9191
`- uses: <your-username>/github-action@<your-branch>`
9292

@@ -110,7 +110,7 @@ This information is for Cypress.io Members or Collaborators who merge pull reque
110110
BREAKING CHANGE: requires minimum Node.js 16 to run
111111
```
112112
113-
1. New versions of this action will be released automatically by the CI when merged to the `master` branch, see [.github/workflows/main.yml](.github/workflows/main.yml). This will create a new [GitHub release](https://github.com/cypress-io/github-action/releases) and will update the current `v5` branch. Thus specifying `uses: cypress-io/github-action@v5` selects the new version automatically. This **will not** push the latest release to GitHub Marketplace.
113+
1. New versions of this action will be released automatically by the CI when merged to the `master` branch, see [.github/workflows/main.yml](.github/workflows/main.yml). This will create a new [GitHub release](https://github.com/cypress-io/github-action/releases) and will update the current highest branch from the series `v5`, `v6`, ... etc. Thus specifying `uses: cypress-io/github-action@v6` (or higher version if available) selects the new version automatically. This **will not** push the latest release to GitHub Marketplace.
114114
1. The action's CI is configured to use the [default Angular release rules](https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js). This means that only `feat:`, `fix:` and `perf:` trigger a new release which is then logged to the [releases](https://github.com/cypress-io/github-action/releases) page. Other Angular commit types listed on [Contributing to Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format) can be used for documentation purposes, however they are ignored by the currently configured release process.
115115

116116
## GitHub Marketplace publication

‎README.md

+63-63
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.