Skip to content

Commit b6c642b

Browse files
committed
Replace Material icons with emojis and update workflow paths
- Remove Architecture diagram section from PR Auto-Labeler overview - Replace all Material Design icons (:material-*:) with emojis throughout docs - Navigation links: ⚙️ 📖 💡 ❓ - Rule categories: 🎨 🗄️ 🧪 🔒 📦 ☁️ 💻 📄 - Related rules: 🧪 📦 🔄 🔒 🗄️ 🔐 - Update workflow path references from .github/workflows/pr-auto-labeler.yml@v0.0.1 to @v0.0.1 - Simplify workflow usage examples across all documentation
1 parent 9f0f181 commit b6c642b

9 files changed

Lines changed: 59 additions & 78 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/.github/workflows/pr-auto-labeler.yml@v0.0.1
38+
uses: workflow-kit/pr-auto-labeler@v0.0.1
3939
with:
4040
enabled_rules: '["ui-change", "test-missing", "large-pr"]'
4141
```

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ permissions:
142142
jobs:
143143
label:
144144
runs-on: ubuntu-latest
145-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
145+
uses: workflow-kit/pr-auto-labeler@v0.0.1
146146
with:
147147
# Enable specific rules
148148
enabled_rules: '[
@@ -184,7 +184,7 @@ Run the labeler only on specific conditions:
184184
jobs:
185185
label:
186186
if: github.event.pull_request.draft == false
187-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
187+
uses: workflow-kit/pr-auto-labeler@v0.0.1
188188
with:
189189
enabled_rules: '["ui-change", "test-missing"]'
190190
```
@@ -206,7 +206,7 @@ Run the labeler only on specific conditions:
206206
jobs:
207207
label:
208208
if: github.actor != 'dependabot[bot]'
209-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
209+
uses: workflow-kit/pr-auto-labeler@v0.0.1
210210
with:
211211
enabled_rules: '["ui-change"]'
212212
```
@@ -219,13 +219,13 @@ Run different rule sets based on file paths:
219219
jobs:
220220
label-frontend:
221221
if: contains(github.event.pull_request.changed_files, 'frontend/')
222-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
222+
uses: workflow-kit/pr-auto-labeler@v0.0.1
223223
with:
224224
enabled_rules: '["ui-change", "style-change", "test-missing"]'
225225
226226
label-backend:
227227
if: contains(github.event.pull_request.changed_files, 'backend/')
228-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
228+
uses: workflow-kit/pr-auto-labeler@v0.0.1
229229
with:
230230
enabled_rules: '["migration", "security-change", "test-missing"]'
231231
```
@@ -294,7 +294,7 @@ Rules are organized into categories. Here's a quick reference:
294294
When v1.0.0 is released, update the version reference:
295295

296296
```yaml hl_lines="2"
297-
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v0.0.1
297+
uses: workflow-kit/pr-auto-labeler@v0.0.1
298298
# Change to:
299299
uses: workflow-kit/pr-auto-labeler/.github/workflows/pr-auto-labeler.yml@v1.0.0
300300
```
@@ -305,7 +305,7 @@ Check the [Changelog](https://github.com/workflow-kit/pr-auto-labeler/releases)
305305

306306
## Next Steps
307307

308-
- [:material-book-open-variant: Explore All Rules](rules/index.md)
309-
- [:material-lightbulb-on: See Configuration Examples](examples.md)
310-
- [:material-help-circle: Troubleshooting Guide](troubleshooting.md)
308+
- [📖 Explore All Rules](rules/index.md)
309+
- [💡 See Configuration Examples](examples.md)
310+
- [ Troubleshooting Guide](troubleshooting.md)
311311

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/.github/workflows/pr-auto-labeler.yml@v0.0.1
26+
uses: workflow-kit/pr-auto-labeler@v0.0.1
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
151+
uses: workflow-kit/pr-auto-labeler@v0.0.1
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
191+
uses: workflow-kit/pr-auto-labeler@v0.0.1
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
217+
uses: workflow-kit/pr-auto-labeler@v0.0.1
218218
with:
219219
enabled_rules: '["ui-change", "migration"]'
220220

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

Lines changed: 5 additions & 24 deletions
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
114+
uses: workflow-kit/pr-auto-labeler@v0.0.1
115115
with:
116116
enabled_rules: '["ui-change", "test-missing", "large-pr"]'
117117
```
@@ -131,25 +131,25 @@ enable_debug: true
131131

132132
<div class="grid" markdown>
133133

134-
=== ":material-rocket-launch: Quick Start"
134+
=== "🚀 Quick Start"
135135

136136
Get up and running in 5 minutes
137137

138138
[Quick Start Guide →](quick-start.md)
139139

140-
=== ":material-cog: Configuration"
140+
=== "⚙️ Configuration"
141141

142142
Learn all configuration options
143143

144144
[Configuration Guide →](configuration.md)
145145

146-
=== ":material-book-open-variant: Rules Reference"
146+
=== "📖 Rules Reference"
147147

148148
Explore all 30+ available rules
149149

150150
[Rules Reference →](rules/index.md)
151151

152-
=== ":material-lightbulb-on: Examples"
152+
=== "💡 Examples"
153153

154154
See real-world usage examples
155155

@@ -159,25 +159,6 @@ enable_debug: true
159159

160160
---
161161

162-
## Architecture
163-
164-
```mermaid
165-
flowchart LR
166-
PR[Pull Request Event] --> Action[PR Auto-Labeler]
167-
Action --> Files[Analyze Changed Files]
168-
Action --> Patterns[Check Code Patterns]
169-
Action --> Meta[Review PR Metadata]
170-
171-
Files --> Rules{Enabled Rules}
172-
Patterns --> Rules
173-
Meta --> Rules
174-
175-
Rules --> Labels[Apply Labels]
176-
Labels --> GitHub[GitHub PR]
177-
```
178-
179-
---
180-
181162
!!! tip "Need Help?"
182163
- [:material-book-open: Browse Documentation](quick-start.md)
183164
- [:material-chat: Ask in Discussions](https://github.com/workflow-kit/pr-auto-labeler/discussions)

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

Lines changed: 5 additions & 5 deletions
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/.github/workflows/pr-auto-labeler.yml@v0.0.1 # (4)!
40+
uses: workflow-kit/pr-auto-labeler@v0.0.1 # (4)!
4141
with:
4242
enabled_rules: '["ui-change", "test-missing", "large-pr"]' # (5)!
4343
```
@@ -214,10 +214,10 @@ Choose a preset based on your team's needs:
214214

215215
Now that you have the basics working:
216216

217-
- [:material-cog: Learn All Configuration Options](configuration.md)
218-
- [:material-book-open-variant: Explore All Available Rules](rules/index.md)
219-
- [:material-lightbulb-on: See Real-World Examples](examples.md)
220-
- [:material-help-circle: View Troubleshooting Guide](troubleshooting.md)
217+
- [⚙️ Learn All Configuration Options](configuration.md)
218+
- [📖 Explore All Available Rules](rules/index.md)
219+
- [💡 See Real-World Examples](examples.md)
220+
- [ View Troubleshooting Guide](troubleshooting.md)
221221

222222
---
223223

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

Lines changed: 4 additions & 4 deletions
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
176+
uses: workflow-kit/pr-auto-labeler@v0.0.1
177177
with:
178178
enabled_rules: '["risky-migration"]'
179179
@@ -226,9 +226,9 @@ jobs:
226226

227227
## Related Rules
228228

229-
- [**test-missing**](testing.md#test-missing) :material-test-tube: — Ensure migrations have tests
230-
- [**security-change**](security.md#security-change) :material-shield-lock: — Sensitive data access
231-
- [**large-pr**](meta.md#large-pr) :material-file-document: — Large migration files
229+
- [**test-missing**](testing.md#test-missing) 🧪 — Ensure migrations have tests
230+
- [**security-change**](security.md#security-change) 🔒 — Sensitive data access
231+
- [**large-pr**](meta.md#large-pr) 📄 — Large migration files
232232

233233
[← Back to Rules Overview](index.md){ .md-button }
234234

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

Lines changed: 4 additions & 4 deletions
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
223+
uses: workflow-kit/pr-auto-labeler@v0.0.1
224224
with:
225225
enabled_rules: '["ui-change"]'
226226
@@ -274,9 +274,9 @@ Use GitHub branch protection to require reviews:
274274

275275
## Related Rules
276276

277-
- [**test-missing**](testing.md#test-missing) :material-test-tube: — Check if UI changes include tests
278-
- [**dependency-change**](dependencies.md#dependency-change) :material-package: — Track UI library updates
279-
- [**refactor**](semantics.md#refactor) :material-code-braces: — Detect UI refactoring
277+
- [**test-missing**](testing.md#test-missing) 🧪 — Check if UI changes include tests
278+
- [**dependency-change**](dependencies.md#dependency-change) 📦 — Track UI library updates
279+
- [**refactor**](semantics.md#refactor) 🔄 — Detect UI refactoring
280280

281281
---
282282

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,71 +24,71 @@ Rules are organized into **9 categories** based on what they detect. Each rule:
2424

2525
<div class="grid cards" markdown>
2626

27-
- :material-palette:{ .lg .middle } __Frontend & UI__
27+
- 🎨 __Frontend & UI__
2828

2929
---
3030

3131
Detect changes to UI components and styles
3232

3333
**2 rules** | [View Details →](frontend.md)
3434

35-
- :material-database:{ .lg .middle } __Database__
35+
- 🗄️ __Database__
3636

3737
---
3838

3939
Track migrations and schema changes
4040

4141
**4 rules** | [View Details →](database.md)
4242

43-
- :material-cog:{ .lg .middle } __Environment & Config__
43+
- ⚙️ __Environment & Config__
4444

4545
---
4646

4747
Monitor configuration and environment changes
4848

4949
**3 rules** | [View Details →](environment.md)
5050

51-
- :material-test-tube:{ .lg .middle } __Testing__
51+
- 🧪 __Testing__
5252

5353
---
5454

5555
Ensure test coverage and quality
5656

5757
**3 rules** | [View Details →](testing.md)
5858

59-
- :material-package:{ .lg .middle } __Dependencies__
59+
- 📦 __Dependencies__
6060

6161
---
6262

6363
Track dependency additions and updates
6464

6565
**3 rules** | [View Details →](dependencies.md)
6666

67-
- :material-cloud:{ .lg .middle } __CI/CD & Infrastructure__
67+
- ☁️ __CI/CD & Infrastructure__
6868

6969
---
7070

7171
Monitor infrastructure and deployment configs
7272

7373
**3 rules** | [View Details →](infrastructure.md)
7474

75-
- :material-shield-lock:{ .lg .middle } __Security__
75+
- 🔒 __Security__
7676

7777
---
7878

7979
Flag security-sensitive changes
8080

8181
**2 rules** | [View Details →](security.md)
8282

83-
- :material-code-braces:{ .lg .middle } __Code Semantics__
83+
- 💻 __Code Semantics__
8484

8585
---
8686

8787
Detect feature additions, refactors, and breaking changes
8888

8989
**4 rules** | [View Details →](semantics.md)
9090

91-
- :material-file-document:{ .lg .middle } __PR Metadata__
91+
- 📄 __PR Metadata__
9292

9393
---
9494

@@ -354,19 +354,19 @@ enable_debug: true
354354
355355
Explore detailed documentation for each rule category:
356356
357-
1. [:material-palette: Frontend & UI Rules](frontend.md)
358-
2. [:material-database: Database Rules](database.md)
359-
3. [:material-cog: Environment & Config Rules](environment.md)
360-
4. [:material-test-tube: Testing Rules](testing.md)
361-
5. [:material-package: Dependency Rules](dependencies.md)
362-
6. [:material-cloud: CI/CD & Infrastructure Rules](infrastructure.md)
363-
7. [:material-shield-lock: Security Rules](security.md)
364-
8. [:material-code-braces: Code Semantics Rules](semantics.md)
365-
9. [:material-file-document: PR Metadata Rules](meta.md)
357+
1. [🎨 Frontend & UI Rules](frontend.md)
358+
2. [🗄️ Database Rules](database.md)
359+
3. [⚙️ Environment & Config Rules](environment.md)
360+
4. [🧪 Testing Rules](testing.md)
361+
5. [📦 Dependency Rules](dependencies.md)
362+
6. [☁️ CI/CD & Infrastructure Rules](infrastructure.md)
363+
7. [🔒 Security Rules](security.md)
364+
8. [💻 Code Semantics Rules](semantics.md)
365+
9. [📄 PR Metadata Rules](meta.md)
366366
367367
Or jump to:
368368
369-
- [:material-lightbulb-on: Usage Examples](../examples.md)
370-
- [:material-cog: Configuration Guide](../configuration.md)
371-
- [:material-help-circle: Troubleshooting](../troubleshooting.md)
369+
- [💡 Usage Examples](../examples.md)
370+
- [⚙️ Configuration Guide](../configuration.md)
371+
- [ Troubleshooting](../troubleshooting.md)
372372

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

Lines changed: 6 additions & 6 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/.github/workflows/pr-auto-labeler.yml@v0.0.1
84+
uses: workflow-kit/pr-auto-labeler@v0.0.1
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
183+
uses: workflow-kit/pr-auto-labeler@v0.0.1
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/.github/workflows/pr-auto-labeler.yml@v0.0.1
231+
uses: workflow-kit/pr-auto-labeler@v0.0.1
232232
with:
233233
enabled_rules: '[
234234
"security-change",
@@ -313,9 +313,9 @@ jobs:
313313

314314
## Related Rules
315315

316-
- [**potential-secret-leak**](environment.md#potential-secret-leak) :material-cog: — Detect leaked secrets
317-
- [**risky-migration**](database.md#risky-migration) :material-database: — Database security
318-
- [**test-missing**](testing.md#test-missing) :material-test-tube: — Ensure security tests
316+
- [**potential-secret-leak**](environment.md#potential-secret-leak) 🔐 — Detect leaked secrets
317+
- [**risky-migration**](database.md#risky-migration) 🗄️ — Database security
318+
- [**test-missing**](testing.md#test-missing) 🧪 — Ensure security tests
319319

320320
[← Back to Rules Overview](index.md){ .md-button }
321321

0 commit comments

Comments
 (0)