Skip to content

Commit d7cc252

Browse files
authored
docs: improve "explicit version" section in readme (#852)
1 parent a29a621 commit d7cc252

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- [End-to-End](#end-to-end-testing) testing
88
- [Component](#component-testing) testing
9-
- [Explicit version](#explicit-version)
9+
- Select [action version](#action-version)
1010
- Run tests in a given [browser](#browser)
1111
- using [Chrome](#chrome)
1212
- using [Firefox](#firefox)
@@ -102,25 +102,27 @@ jobs:
102102

103103
See the example project [component-tests](examples/component-tests/) and the [example-component-test.yml](.github/workflows/example-component-test.yml) workflow for more details.
104104

105-
### Explicit version
105+
### Action version
106106

107107
**Best practice:**
108108

109-
Our examples specify the tag of the action to use listing only the major version `@v5`
109+
Our examples specify using branch [v5](https://github.com/cypress-io/github-action/tree/v5) which is the action's latest major version:
110110

111111
```yml
112112
- name: Cypress run
113113
uses: cypress-io/github-action@v5
114114
```
115115

116-
When using `cypress-io/github-action@v5` from your workflow file, you automatically will be using the latest [tagged version from this repository](https://github.com/cypress-io/github-action/tags). If you want to precisely control the version of this module, use the full tag version, for example:
116+
When using `cypress-io/github-action@v5` 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).
117+
118+
Alternatively, to mitigate unforeseen breaks, bind to a specific [tag](https://github.com/cypress-io/github-action/tags), for example:
117119

118120
```yml
119121
- name: Cypress run
120122
uses: cypress-io/[email protected]
121123
```
122124

123-
By using the full version tag, you will avoid accidentally using a newer version of the action.
125+
The changes associated with each tag are shown under GitHub's [releases](https://github.com/cypress-io/github-action/releases) list. Refer also to the [Changelog](#changelog) for an overview of major changes.
124126

125127
### Browser
126128

0 commit comments

Comments
 (0)