Skip to content

Commit 4f30eac

Browse files
authored
Merge pull request #1 from workflow-kit/update-workflow-path-format
Update docs to use workflow file path format
2 parents b6c642b + 6f303fc commit 4f30eac

8 files changed

Lines changed: 20 additions & 21 deletions

File tree

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ permissions:
3535

3636
jobs:
3737
label:
38-
uses: workflow-kit/pr-auto-labeler@v0.0.1
38+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
3939
with:
4040
enabled_rules: '["ui-change", "test-missing", "large-pr"]'
4141
```

docs/workflows/pr-auto-labeler/configuration.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,7 @@ permissions:
141141
142142
jobs:
143143
label:
144-
runs-on: ubuntu-latest
145-
uses: workflow-kit/pr-auto-labeler@v0.0.1
144+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
146145
with:
147146
# Enable specific rules
148147
enabled_rules: '[
@@ -184,7 +183,7 @@ Run the labeler only on specific conditions:
184183
jobs:
185184
label:
186185
if: github.event.pull_request.draft == false
187-
uses: workflow-kit/pr-auto-labeler@v0.0.1
186+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
188187
with:
189188
enabled_rules: '["ui-change", "test-missing"]'
190189
```
@@ -206,7 +205,7 @@ Run the labeler only on specific conditions:
206205
jobs:
207206
label:
208207
if: github.actor != 'dependabot[bot]'
209-
uses: workflow-kit/pr-auto-labeler@v0.0.1
208+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
210209
with:
211210
enabled_rules: '["ui-change"]'
212211
```
@@ -219,13 +218,13 @@ Run different rule sets based on file paths:
219218
jobs:
220219
label-frontend:
221220
if: contains(github.event.pull_request.changed_files, 'frontend/')
222-
uses: workflow-kit/pr-auto-labeler@v0.0.1
221+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
223222
with:
224223
enabled_rules: '["ui-change", "style-change", "test-missing"]'
225224
226225
label-backend:
227226
if: contains(github.event.pull_request.changed_files, 'backend/')
228-
uses: workflow-kit/pr-auto-labeler@v0.0.1
227+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
229228
with:
230229
enabled_rules: '["migration", "security-change", "test-missing"]'
231230
```
@@ -289,14 +288,14 @@ Rules are organized into categories. Here's a quick reference:
289288

290289
## Migration Guide
291290

292-
### From v0.0.1 to v1.0.0 (Future)
291+
### From v0.0.1 to Latest
293292

294-
When v1.0.0 is released, update the version reference:
293+
Update to use the workflow file path format:
295294

296295
```yaml hl_lines="2"
297296
uses: workflow-kit/pr-auto-labeler@v0.0.1
298297
# Change to:
299-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v1.0.0
298+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
300299
```
301300

302301
Check the [Changelog](https://github.com/workflow-kit/pr-auto-labeler/releases) for breaking changes.

docs/workflows/pr-auto-labeler/examples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ permissions:
2323

2424
jobs:
2525
label:
26-
uses: workflow-kit/pr-auto-labeler@v0.0.1
26+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
2727
with:
2828
enabled_rules: '[
2929
"ui-change",
@@ -148,7 +148,7 @@ enabled_rules: '[
148148
```yaml
149149
jobs:
150150
label:
151-
uses: workflow-kit/pr-auto-labeler@v0.0.1
151+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
152152
with:
153153
enabled_rules: '["ui-change", "security-change"]'
154154

@@ -188,7 +188,7 @@ Fail the workflow for dangerous patterns:
188188
```yaml
189189
jobs:
190190
label:
191-
uses: workflow-kit/pr-auto-labeler@v0.0.1
191+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
192192
with:
193193
enabled_rules: '["risky-code", "risky-migration"]'
194194

@@ -214,7 +214,7 @@ Run tests based on labels:
214214
```yaml
215215
jobs:
216216
label:
217-
uses: workflow-kit/pr-auto-labeler@v0.0.1
217+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
218218
with:
219219
enabled_rules: '["ui-change", "migration"]'
220220

docs/workflows/pr-auto-labeler/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ enable_debug: true
111111

112112
jobs:
113113
label:
114-
uses: workflow-kit/pr-auto-labeler@v0.0.1
114+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
115115
with:
116116
enabled_rules: '["ui-change", "test-missing", "large-pr"]'
117117
```

docs/workflows/pr-auto-labeler/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ permissions:
3737

3838
jobs:
3939
label:
40-
uses: workflow-kit/pr-auto-labeler@v0.0.1 # (4)!
40+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest # (4)!
4141
with:
4242
enabled_rules: '["ui-change", "test-missing", "large-pr"]' # (5)!
4343
```

docs/workflows/pr-auto-labeler/rules/database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ enabled_rules: '[
173173
```yaml
174174
jobs:
175175
label:
176-
uses: workflow-kit/pr-auto-labeler@v0.0.1
176+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
177177
with:
178178
enabled_rules: '["risky-migration"]'
179179

docs/workflows/pr-auto-labeler/rules/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Trigger visual regression tests on UI changes:
220220
```yaml
221221
jobs:
222222
label:
223-
uses: workflow-kit/pr-auto-labeler@v0.0.1
223+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
224224
with:
225225
enabled_rules: '["ui-change"]'
226226

docs/workflows/pr-auto-labeler/rules/security.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Require security team review:
8181
```yaml
8282
jobs:
8383
label:
84-
uses: workflow-kit/pr-auto-labeler@v0.0.1
84+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
8585
with:
8686
enabled_rules: '["security-change"]'
8787

@@ -180,7 +180,7 @@ Block PRs with risky code using GitHub Actions:
180180
```yaml
181181
jobs:
182182
label:
183-
uses: workflow-kit/pr-auto-labeler@v0.0.1
183+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
184184
with:
185185
enabled_rules: '["risky-code"]'
186186
@@ -228,7 +228,7 @@ permissions:
228228
jobs:
229229
security-labels:
230230
runs-on: ubuntu-latest
231-
uses: workflow-kit/pr-auto-labeler@v0.0.1
231+
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@latest
232232
with:
233233
enabled_rules: '[
234234
"security-change",

0 commit comments

Comments
 (0)