Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: recommend v6 as standard action version #1014

Merged
merged 1 commit into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/example-basic-pnpm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- name: Cypress tests
# normally you would write
# uses: cypress-io/github-action@v5
# uses: cypress-io/github-action@v6
uses: ./
# the parameters below are only necessary
# because we are running these examples in a monorepo
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/example-basic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:

- name: Cypress tests
# normally you would write
# uses: cypress-io/github-action@v5
# uses: cypress-io/github-action@v6
uses: ./
# the parameters below are only necessary
# because we are running these examples in a monorepo
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/example-component-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
uses: actions/checkout@v3
- name: Cypress run
# normally you would write
# uses: cypress-io/github-action@v5
# uses: cypress-io/github-action@v6
uses: ./
with:
working-directory: examples/component-tests
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/example-recording.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:

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

- name: Cypress tests
# normally you would write
# uses: cypress-io/github-action@v5
# uses: cypress-io/github-action@v6
uses: ./
with:
working-directory: examples/recording
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ which calls the action code from the branch they are running in when the workflo
From another (external) repository, the production version of the action is called with

```yaml
- uses: cypress-io/github-action@v5
- uses: cypress-io/github-action@v6
```

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:
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:

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

Expand All @@ -110,7 +110,7 @@ This information is for Cypress.io Members or Collaborators who merge pull reque
BREAKING CHANGE: requires minimum Node.js 16 to run
```
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.
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.
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.

## GitHub Marketplace publication
Expand Down
Loading