Skip to content

Commit 3a4d121

Browse files
authored
docs: add changelog for 6.3.0 and 6.40 (#1016)
correct remaining references to v5
1 parent 7215fc1 commit 3a4d121

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ See [Releases](https://github.com/cypress-io/github-action/releases) for full de
66

77
| Version | Changes |
88
| ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
9+
| v6.4.0 | Action adds PR number and URL if available when recording |
10+
| v6.3.0 | v6 is recommended action version |
911
| v6.2.0 | Examples updated to Cypress 13 |
1012
| v6.1.0 | Examples for Cypress 9 archived in action's [v5](https://github.com/cypress-io/github-action/tree/v5) branch |
1113
| v6.0.0 | Action runs under Node.js 20 instead of Node.js 16. |

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,14 @@ See the example project [component-tests](examples/component-tests/) and the [ex
117117

118118
**Best practice:**
119119

120-
Our examples specify using branch [v5](https://github.com/cypress-io/github-action/tree/v5) which is the action's recommended major version:
120+
Our examples specify using branch [v6](https://github.com/cypress-io/github-action/tree/v6) which is the action's recommended major version:
121121

122122
```yml
123123
- name: Cypress run
124124
uses: cypress-io/github-action@v6
125125
```
126126

127-
When using `cypress-io/github-action@v6` from your workflow file, you will automatically use the latest [tag](https://github.com/cypress-io/github-action/tags) from branch [v5](https://github.com/cypress-io/github-action/tree/v5).
127+
When using `cypress-io/github-action@v6` from your workflow file, you will automatically use the latest [tag](https://github.com/cypress-io/github-action/tags) from branch [v6](https://github.com/cypress-io/github-action/tree/v6).
128128

129129
Alternatively, to mitigate unforeseen breaks, bind to a specific [tag](https://github.com/cypress-io/github-action/tags), for example:
130130

@@ -1464,7 +1464,7 @@ jobs:
14641464

14651465
### Automatic PR number & URL detection
14661466

1467-
When recording runs to Cypress Cloud, the PR number and URL can be automatically detected if you pass `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}`
1467+
When recording runs to Cypress Cloud, the PR number and URL can be automatically detected if you pass `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}`
14681468
via the workflow `env`. When set, this value enables the Action to perform additional logic that grabs the related PR number and URL (if they
14691469
exist) and sets them in the environment variables `CYPRESS_PULL_REQUEST_ID` and `CYPRESS_PULL_REQUEST_URL`, respectively.
14701470
* See Cypress' documentation on [CI Build Information](https://on.cypress.io/guides/continuous-integration/introduction#CI-Build-Information)
@@ -1497,7 +1497,7 @@ PR that triggered the workflow.
14971497

14981498
#### Triggering event: `push`
14991499

1500-
When a commit on a branch without a PR is made, the Cypress GitHub Action checks to see if the commit that triggered the workflow has a
1500+
When a commit on a branch without a PR is made, the Cypress GitHub Action checks to see if the commit that triggered the workflow has a
15011501
related PR. If the commit exists in any other PRs, it's considered a related PR. When there are related PRs, we grab the first related PR
15021502
and use that PR's number and URL for `CYPRESS_PULL_REQUEST_ID` and `CYPRESS_PULL_REQUEST_URL`, respectively.
15031503

0 commit comments

Comments
 (0)