@@ -4,7 +4,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
44
55## Core CI/CD Workflows
66
7- ### 🔨 [ ci.yml] ( .github/ workflows/ci.yml)
7+ ### 🔨 [ ci.yml] ( workflows/ci.yml )
88** Purpose:** Main continuous integration pipeline
99** Triggers:** Push to ` main ` , Pull Requests
1010** What it does:**
@@ -14,7 +14,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
1414- Runs test suite across all packages
1515- Sets up Redis and MongoDB for driver tests
1616
17- ### 📊 [ coverage.yml] ( .github/ workflows/coverage.yml) ✨ NEW
17+ ### 📊 [ coverage.yml] ( workflows/coverage.yml ) ✨ NEW
1818** Purpose:** Test coverage tracking and reporting
1919** Triggers:** Push to ` main ` , Pull Requests
2020** What it does:**
@@ -23,7 +23,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
2323- Provides coverage insights on PRs
2424- Tracks coverage trends over time
2525
26- ### ✅ [ typecheck.yml] ( .github/ workflows/typecheck.yml)
26+ ### ✅ [ typecheck.yml] ( workflows/typecheck.yml )
2727** Purpose:** TypeScript type checking
2828** Triggers:** Push to ` main ` , Pull Requests
2929** What it does:**
@@ -33,7 +33,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
3333
3434## Release & Publishing
3535
36- ### 🚀 [ release.yml] ( .github/ workflows/release.yml)
36+ ### 🚀 [ release.yml] ( workflows/release.yml )
3737** Purpose:** Automated package publishing
3838** Triggers:** Push to ` main `
3939** What it does:**
@@ -42,7 +42,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
4242- Publishes packages to npm when merged
4343- Requires NPM_TOKEN secret
4444
45- ### 📝 [ changelog-preview.yml] ( .github/ workflows/changelog-preview.yml) ✨ NEW
45+ ### 📝 [ changelog-preview.yml] ( workflows/changelog-preview.yml ) ✨ NEW
4646** Purpose:** Preview changelog before release
4747** Triggers:** Pull Requests
4848** What it does:**
@@ -52,15 +52,15 @@ This document describes all the GitHub Actions workflows configured for the Obje
5252
5353## Code Quality & Security
5454
55- ### 🔒 [ codeql.yml] ( .github/ workflows/codeql.yml)
55+ ### 🔒 [ codeql.yml] ( workflows/codeql.yml )
5656** Purpose:** Security scanning with CodeQL
5757** Triggers:** Push to ` main ` , Pull Requests, Weekly schedule
5858** What it does:**
5959- Scans JavaScript/TypeScript code for vulnerabilities
6060- Runs security analysis
6161- Creates security alerts for issues found
6262
63- ### 🔍 [ dependency-review.yml] ( .github/ workflows/dependency-review.yml)
63+ ### 🔍 [ dependency-review.yml] ( workflows/dependency-review.yml )
6464** Purpose:** Dependency security review
6565** Triggers:** Pull Requests
6666** What it does:**
@@ -69,7 +69,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
6969- Fails on moderate or higher severity issues
7070- Comments on PRs with findings
7171
72- ### ✓ [ validate-metadata.yml] ( .github/ workflows/validate-metadata.yml)
72+ ### ✓ [ validate-metadata.yml] ( workflows/validate-metadata.yml )
7373** Purpose:** Validate ObjectQL metadata files
7474** Triggers:** Changes to ` *.object.yml ` , ` *.validation.yml ` , etc.
7575** What it does:**
@@ -79,15 +79,15 @@ This document describes all the GitHub Actions workflows configured for the Obje
7979
8080## Documentation
8181
82- ### 📚 [ deploy-docs.yml] ( .github/ workflows/deploy-docs.yml)
82+ ### 📚 [ deploy-docs.yml] ( workflows/deploy-docs.yml )
8383** Purpose:** Deploy documentation to GitHub Pages
8484** Triggers:** Push to ` main ` (docs changes), Manual dispatch
8585** What it does:**
8686- Builds VitePress documentation site
8787- Deploys to GitHub Pages
8888- Makes docs available at objectql.org
8989
90- ### 🔗 [ link-checker.yml] ( .github/ workflows/link-checker.yml) ✨ NEW
90+ ### 🔗 [ link-checker.yml] ( workflows/link-checker.yml ) ✨ NEW
9191** Purpose:** Check for broken links in documentation
9292** Triggers:** Push/PR with doc changes, Weekly schedule, Manual
9393** What it does:**
@@ -98,15 +98,15 @@ This document describes all the GitHub Actions workflows configured for the Obje
9898
9999## Repository Automation
100100
101- ### 🏷️ [ labeler.yml] ( .github/ workflows/labeler.yml)
101+ ### 🏷️ [ labeler.yml] ( workflows/labeler.yml )
102102** Purpose:** Auto-label PRs based on files changed
103103** Triggers:** Pull Requests (opened, synchronized, reopened)
104104** What it does:**
105105- Adds labels like ` 📦 dependencies ` , ` 🏗️ foundation ` , ` 🔌 drivers `
106106- Based on file paths changed
107107- Helps with PR organization and filtering
108108
109- ### 📏 [ pr-size-labeler.yml] ( .github/ workflows/pr-size-labeler.yml) ✨ NEW
109+ ### 📏 [ pr-size-labeler.yml] ( workflows/pr-size-labeler.yml ) ✨ NEW
110110** Purpose:** Label PRs by size
111111** Triggers:** Pull Requests (opened, synchronized, reopened)
112112** What it does:**
@@ -115,15 +115,15 @@ This document describes all the GitHub Actions workflows configured for the Obje
115115- Ignores lock files and markdown
116116- Encourages smaller, reviewable PRs
117117
118- ### 👋 [ welcome.yml] ( .github/ workflows/welcome.yml) ✨ NEW
118+ ### 👋 [ welcome.yml] ( workflows/welcome.yml ) ✨ NEW
119119** Purpose:** Welcome first-time contributors
120120** Triggers:** First issue or PR from a new contributor
121121** What it does:**
122122- Posts welcoming message on first issue
123123- Provides PR checklist for first-time contributors
124124- Links to documentation and guidelines
125125
126- ### 🗑️ [ stale.yml] ( .github/ workflows/stale.yml)
126+ ### 🗑️ [ stale.yml] ( workflows/stale.yml )
127127** Purpose:** Manage stale issues and PRs
128128** Triggers:** Daily schedule, Manual dispatch
129129** What it does:**
@@ -132,7 +132,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
132132- Exempts labeled issues: ` pinned ` , ` security ` , ` roadmap `
133133- Helps keep issue tracker organized
134134
135- ### 🧹 [ cleanup-runs.yml] ( .github/ workflows/cleanup-runs.yml) ✨ NEW
135+ ### 🧹 [ cleanup-runs.yml] ( workflows/cleanup-runs.yml ) ✨ NEW
136136** Purpose:** Clean up old workflow runs
137137** Triggers:** Weekly schedule (Sunday), Manual dispatch
138138** What it does:**
@@ -143,7 +143,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
143143
144144## Dependency Management
145145
146- ### 🤖 [ auto-approve-dependabot.yml] ( .github/ workflows/auto-approve-dependabot.yml) ✨ NEW
146+ ### 🤖 [ auto-approve-dependabot.yml] ( workflows/auto-approve-dependabot.yml ) ✨ NEW
147147** Purpose:** Streamline Dependabot PR approvals
148148** Triggers:** Dependabot Pull Requests
149149** What it does:**
@@ -154,7 +154,7 @@ This document describes all the GitHub Actions workflows configured for the Obje
154154
155155## Performance Testing
156156
157- ### ⚡ [ benchmark.yml] ( .github/ workflows/benchmark.yml) ✨ NEW
157+ ### ⚡ [ benchmark.yml] ( workflows/benchmark.yml ) ✨ NEW
158158** Purpose:** Track performance benchmarks
159159** Triggers:** Push to ` main ` , Pull Requests, Manual
160160** What it does:**
@@ -167,10 +167,10 @@ This document describes all the GitHub Actions workflows configured for the Obje
167167
168168## Configuration Files
169169
170- ### [ labeler.yml] ( .github/ labeler.yml)
170+ ### [ labeler.yml] ( labeler.yml )
171171Configuration for the PR auto-labeler, mapping file paths to labels.
172172
173- ### [ markdown-link-check-config.json] ( .github/ markdown-link-check-config.json) ✨ NEW
173+ ### [ markdown-link-check-config.json] ( markdown-link-check-config.json ) ✨ NEW
174174Configuration for the link checker, including patterns to ignore (localhost, example.com).
175175
176176---
0 commit comments