This directory contains GitHub-specific configuration files for CI/CD and branch protection.
-
workflows/ci.yml- Continuous Integration pipeline- Runs on every PR to main
- Jobs: Lint, Type Check, Build, Test
- Blocks merging if any job fails
-
workflows/release.yml- Automated releases- Runs when PRs merge to main
- Creates Release PRs automatically
- Publishes to npm when Release PR merges
QUICK-START-CI.md- Quick setup guide (start here!)CI-CD-GUIDE.md- Comprehensive CI/CD documentationSETUP-CHECKLIST.md- Step-by-step setup checklist
../scripts/setup-branch-protection.js- Automated branch protection setup
-
Review the setup:
cat .github/QUICK-START-CI.md
-
Push workflows to GitHub:
git add .github/ git commit -m "ci: add CI/CD workflows" git push origin main -
Set up branch protection:
pnpm setup:branch-protection
-
Test the CI:
- Create a test PR
- Verify CI runs automatically
- Verify all checks pass
- See
QUICK-START-CI.mdfor immediate next steps - See
CI-CD-GUIDE.mdfor detailed workflow documentation - See
SETUP-CHECKLIST.mdto track your setup progress
- Root:
package.json- Containssetup:branch-protectionscript - Root:
.changeset/config.json- Changeset configuration - Root:
DX-GUIDE.md- Developer experience guide - Root:
WORKFLOW.md- Development workflow overview
Questions? Check the documentation files in this directory.