Skip to content

Commit bb0138e

Browse files
committedSep 30, 2022
Add section about versioning
1 parent ceace68 commit bb0138e

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed
 

‎README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,25 @@ jobs:
2020
runs-on: ubuntu-latest
2121
steps:
2222
- name: Cancel Previous Runs
23-
uses: styfle/cancel-workflow-action@0.10.0
23+
uses: styfle/cancel-workflow-action
2424
#- name: Run Tests
2525
# uses: actions/setup-node@v1
2626
# run: node test.js
2727
# ... etc
2828
```
2929

30+
### Versioning
31+
32+
It is recommended to pin a specific version of this action so you don't automatically upgrade to the latest which could introduce breaking changes.
33+
34+
```yml
35+
uses: styfle/cancel-workflow-action@0.9.1
36+
```
37+
38+
Notice there is no `v` prefix, just the `@major.minor.patch` version.
39+
40+
Visit [Releases](https://github.com/styfle/cancel-workflow-action/releases) to find the latest version at the top of the page.
41+
3042
### Advanced: Canceling Other Workflows
3143

3244
In some cases, you may wish to avoid modifying all your workflows and instead create a new workflow that cancels your other workflows. This can be useful when you have a problem with workflows getting queued.
@@ -43,7 +55,7 @@ jobs:
4355
runs-on: ubuntu-latest
4456
timeout-minutes: 3
4557
steps:
46-
- uses: styfle/cancel-workflow-action@0.10.0
58+
- uses: styfle/cancel-workflow-action
4759
with:
4860
workflow_id: 479426
4961
```
@@ -72,7 +84,7 @@ jobs:
7284
cancel:
7385
runs-on: ubuntu-latest
7486
steps:
75-
- uses: styfle/cancel-workflow-action@0.10.0
87+
- uses: styfle/cancel-workflow-action
7688
with:
7789
workflow_id: ${{ github.event.workflow.id }}
7890
```
@@ -92,7 +104,7 @@ jobs:
92104
timeout-minutes: 3
93105
steps:
94106
- name: Cancel build runs
95-
uses: styfle/cancel-workflow-action@0.10.0
107+
uses: styfle/cancel-workflow-action
96108
with:
97109
ignore_sha: true
98110
workflow_id: 479426
@@ -113,7 +125,7 @@ jobs:
113125
runs-on: ubuntu-latest
114126
timeout-minutes: 3
115127
steps:
116-
- uses: styfle/cancel-workflow-action@0.10.0
128+
- uses: styfle/cancel-workflow-action
117129
with:
118130
all_but_latest: true
119131
```
@@ -134,7 +146,7 @@ jobs:
134146
actions: write
135147
steps:
136148
- name: Cancel Previous Runs
137-
uses: styfle/cancel-workflow-action@0.10.0
149+
uses: styfle/cancel-workflow-action
138150
with:
139151
access_token: ${{ github.token }}
140152
```

0 commit comments

Comments
 (0)
Please sign in to comment.