Skip to content

Commit 39013c1

Browse files
docs: bump example actions/checkout to v7 (#178)
* docs: bump example actions/checkout to v7; pin example to v0.1.3 The README workflow examples used actions/checkout@v6 (latest is v7) and an illustrative oasdiff-action pin at v0.1.1 (latest is v0.1.3). The recommended oasdiff-action pin (@v0 moving tag) is unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: stop hardcoding an exact action version in the Versioning section The exact-pin example hardcoded a patch version (@v0.1.3) that just goes stale (it was @v0.1.1 before). Keep @v0 as the concrete recommended example and point to the Releases page for users who want to pin an exact tag, so the README has no version number to rot. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: 'examples above' -> 'examples here' in Versioning Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 06e794c commit 39013c1

1 file changed

Lines changed: 11 additions & 17 deletions

File tree

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
breaking-changes:
4040
runs-on: ubuntu-latest
4141
steps:
42-
- uses: actions/checkout@v6
42+
- uses: actions/checkout@v7
4343
- run: git fetch --depth=1 origin ${{ github.base_ref }}
4444
- uses: oasdiff/oasdiff-action/breaking@v0
4545
with:
@@ -55,19 +55,13 @@ This compares your spec on the PR branch against the base branch and fails the w
5555

5656
## Versioning
5757

58-
The examples above pin the action at `@v0`, the moving major-version tag. It always points at the latest `v0.x.y` release, so you get every later patch and minor (including review and PR-comment improvements) automatically, with no workflow change:
58+
The examples here pin the action at `@v0`, the moving major-version tag. It always points at the latest `v0.x.y` release, so you get every later patch and minor (including review and PR-comment improvements) automatically, with no workflow change:
5959

6060
```yaml
6161
- uses: oasdiff/oasdiff-action/breaking@v0
6262
```
6363

64-
`@v0` only advances on stable releases, never on prereleases. If you prefer to control upgrades yourself, pin an exact release instead and bump it when you choose:
65-
66-
```yaml
67-
- uses: oasdiff/oasdiff-action/breaking@v0.1.1
68-
```
69-
70-
`@main` runs the unreleased tip and is meant for trying changes early, not for production.
64+
`@v0` only advances on stable releases, never on prereleases. If you prefer to control upgrades yourself, pin to a specific release tag from the [Releases page](https://github.com/oasdiff/oasdiff-action/releases) and bump it when you choose. `@main` runs the unreleased tip and is meant for trying changes early, not for production.
7165

7266
---
7367

@@ -91,7 +85,7 @@ jobs:
9185
breaking-changes:
9286
runs-on: ubuntu-latest
9387
steps:
94-
- uses: actions/checkout@v6
88+
- uses: actions/checkout@v7
9589
- run: git fetch --depth=1 origin ${{ github.base_ref }}
9690
- uses: oasdiff/oasdiff-action/breaking@v0
9791
with:
@@ -137,7 +131,7 @@ jobs:
137131
changelog:
138132
runs-on: ubuntu-latest
139133
steps:
140-
- uses: actions/checkout@v6
134+
- uses: actions/checkout@v7
141135
- run: git fetch --depth=1 origin ${{ github.base_ref }}
142136
- uses: oasdiff/oasdiff-action/changelog@v0
143137
with:
@@ -179,7 +173,7 @@ jobs:
179173
diff:
180174
runs-on: ubuntu-latest
181175
steps:
182-
- uses: actions/checkout@v6
176+
- uses: actions/checkout@v7
183177
- run: git fetch --depth=1 origin ${{ github.base_ref }}
184178
- uses: oasdiff/oasdiff-action/diff@v0
185179
with:
@@ -214,7 +208,7 @@ jobs:
214208
validate:
215209
runs-on: ubuntu-latest
216210
steps:
217-
- uses: actions/checkout@v6
211+
- uses: actions/checkout@v7
218212
- uses: oasdiff/oasdiff-action/validate@v0
219213
with:
220214
spec: 'openapi.yaml'
@@ -282,7 +276,7 @@ The `base` and `revision` inputs accept:
282276
When using git refs, you need to check out the repo and fetch the base branch:
283277

284278
```yaml
285-
- uses: actions/checkout@v6
279+
- uses: actions/checkout@v7
286280
- run: git fetch --depth=1 origin ${{ github.base_ref }}
287281
```
288282

@@ -305,7 +299,7 @@ jobs:
305299
pr-comment:
306300
runs-on: ubuntu-latest
307301
steps:
308-
- uses: actions/checkout@v6
302+
- uses: actions/checkout@v7
309303
- run: git fetch --depth=1 origin ${{ github.base_ref }}
310304
- uses: oasdiff/oasdiff-action/pr-comment@v0
311305
with:
@@ -353,7 +347,7 @@ jobs:
353347
if: github.event_name == 'pull_request'
354348
runs-on: ubuntu-latest
355349
steps:
356-
- uses: actions/checkout@v6
350+
- uses: actions/checkout@v7
357351
- run: git fetch --depth=1 origin ${{ github.base_ref }}
358352
- uses: oasdiff/oasdiff-action/pr-comment@v0
359353
with:
@@ -364,7 +358,7 @@ jobs:
364358
if: github.event_name == 'workflow_dispatch'
365359
runs-on: ubuntu-latest
366360
steps:
367-
- uses: actions/checkout@v6
361+
- uses: actions/checkout@v7
368362
- run: git fetch --depth=1 origin ${{ github.event.repository.default_branch }}
369363
- uses: oasdiff/oasdiff-action/verify@v0
370364
with:

0 commit comments

Comments
 (0)