Skip to content

Commit 42f9a13

Browse files
author
Ricardo Sanchez
committed
feat(automation): add data validator, json export, enhanced generator and PR template
1 parent 8d533ce commit 42f9a13

File tree

6 files changed

+962
-20
lines changed

6 files changed

+962
-20
lines changed

.github/pull_request_template.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
11
## Summary
22

3-
Describe the change and motivation.
3+
Describe the change and motivation (what problem or gap does this address?).
4+
5+
## Resource / Change Details
6+
7+
If adding or updating resources, list each:
8+
9+
| Name | Change Type (add/update/remove) | Proposed Status | Rationale (1 sentence) |
10+
| ---- | -------------------------------- | --------------- | ---------------------- |
11+
| | | | |
12+
13+
## Status Rationale & Evidence
14+
15+
Provide supporting signals for any new or changed status (stars, release cadence, adoption notes, deprecation notice, etc.). Omit if self-evident (e.g., AWS = core).
416

517
## Checklist
618

7-
- [ ] Updated `_data/resources.yml` (if adding/updating resources)
8-
- [ ] Ran `ruby scripts/generate_readme.rb` locally
9-
- [ ] README diff is committed
10-
- [ ] Link check passes (or false positives explained)
11-
- [ ] Status choices align with taxonomy
12-
- [ ] No direct edits to generated table formatting
19+
- [ ] Updated `_data/resources.yml` (if applicable)
20+
- [ ] Ran `ruby scripts/validate.rb` (passed locally)
21+
- [ ] Ran `ruby scripts/generate_readme.rb` (README regenerated)
22+
- [ ] README diff committed (no manual formatting edits)
23+
- [ ] Link check passes locally or false positives explained
24+
- [ ] Status choices match taxonomy & rationale supplied
25+
- [ ] No duplicate resource names introduced
26+
- [ ] Added status rationale table rows above (if resource changes)
1327

1428
## Type of Change
1529

@@ -19,7 +33,12 @@ Describe the change and motivation.
1933
- [ ] chore
2034
- [ ] refactor
2135
- [ ] ci
36+
- [ ] removal (resource deprecation/removal)
37+
38+
## Breaking Changes
39+
40+
Does this remove or significantly alter an existing resource? If yes, explain impact and reason.
2241

2342
## Notes for Reviewers
2443

25-
(Optional) Anything surprising, rationale for status changes, or link exceptions.
44+
Anything surprising, rationale clarifications, or link checker justifications.

.github/workflows/validate.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Validate Data
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '_data/**'
7+
- 'scripts/validate.rb'
8+
push:
9+
branches: [ main ]
10+
paths:
11+
- '_data/**'
12+
- 'scripts/validate.rb'
13+
workflow_dispatch:
14+
15+
jobs:
16+
validate:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v4
21+
- name: Setup Ruby
22+
uses: ruby/setup-ruby@v1
23+
with:
24+
ruby-version: '3.3'
25+
bundler-cache: false
26+
- name: Run validator
27+
run: ruby scripts/validate.rb

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,26 @@ Status legend:
2121

2222
## Index
2323

24-
- [Blogs](#blogs)
25-
- [Books](#books)
26-
- [Build & Bundling Tools](#build-and-bundling-tools)
27-
- [Cloud Providers & Platforms](#cloud-providers-and-platforms)
28-
- [Code Editors](#code-editors)
29-
- [Code Management](#code-management)
30-
- [Coding Courses & Learning](#coding-courses-and-learning)
31-
- [Databases & Data Systems](#databases-and-data-systems)
32-
- [JavaScript Frameworks & Libraries](#javascript-frameworks-and-libraries)
33-
- [Mockups & Wireframing](#mockups-and-wireframing)
34-
- [AI Tools & Assistants](#ai-tools-and-assistants)
24+
- [Blogs](#blogs) (8)
25+
- [Books](#books) (16)
26+
- [Build & Bundling Tools](#build-and-bundling-tools) (8)
27+
- [Cloud Providers & Platforms](#cloud-providers-and-platforms) (12)
28+
- [Code Editors](#code-editors) (13)
29+
- [Code Management](#code-management) (5)
30+
- [Coding Courses & Learning](#coding-courses-and-learning) (11)
31+
- [Databases & Data Systems](#databases-and-data-systems) (12)
32+
- [JavaScript Frameworks & Libraries](#javascript-frameworks-and-libraries) (11)
33+
- [Mockups & Wireframing](#mockups-and-wireframing) (7)
34+
- [AI Tools & Assistants](#ai-tools-and-assistants) (8)
35+
36+
### Quickstart
37+
38+
1. Update `_data/resources.yml`
39+
2. Run `ruby scripts/validate.rb && ruby scripts/generate_readme.rb`
40+
3. Commit both the YAML and README changes
41+
4. Open a Pull Request (status rationale required if non-obvious)
42+
43+
See `CONTRIBUTING.md` for full details.
3544

3645
<a id="blogs"></a>
3746
### Blogs

0 commit comments

Comments
 (0)