mirror of
https://github.com/alirezarezvani/ClaudeForge.git
synced 2026-07-03 02:13:15 -04:00
Alireza Rezvani
f52664867d
* fix(ci): add missing PR template enhancements - Add CI/CD workflow change type - Expand checklist with quality gates sections - Add Conventional Commits and branch naming reminders - Better organize code quality, docs, testing, CI/CD sections This file was modified in Phase 2 but accidentally not staged. * docs: add comprehensive CI/CD and branching documentation Phase 3: Documentation & Branch Setup Created Documentation (1200+ lines): - GITHUB_WORKFLOWS.md: Complete reference for all 5 workflows and 4 composite actions - Detailed explanations of bootstrap, pr-into-dev, dev-to-main, release workflows - Quality gates documentation (Python, Markdown, Bash, secrets) - Troubleshooting guide for common workflow issues - Configuration examples and customization options - BRANCHING_STRATEGY.md: Standard branching model documentation - feature/* → dev → main flow explained - Branch protection configuration guide - Conventional Commits format with examples - Git commands cheat sheet - Common scenarios and best practices - Merge strategy (squash merges) Updated README.md: - Added CI/CD and Quality Gates badges - Added links to new workflow and branching docs - Better documentation table organization Branch Setup: - Created and pushed dev branch - Ready for branch protection configuration Next: Phase 4 (Claude Code slash commands for GitHub workflows) * feat(commands): add GitHub workflow integration slash commands Phase 4: Claude Code Slash Commands Created 4 GitHub Integration Commands: 1. /github-init - CI/CD system initialization - Runs bootstrap workflow - Creates dev branch - Configures branch protection - Sets default branch to dev - Complete setup verification 2. /commit-smart - Smart commits with quality gates - Pre-commit validation (Python, Bash, secrets) - Conventional Commits format generation - Interactive commit message builder - Quality checks before committing 3. /create-pr - Pull request creation - Branch validation - Target branch detection (dev/main) - PR title generation (Conventional Commits) - PR template population - Workflow trigger explanation 4. /release - GitHub release creation - Version validation (semantic versioning) - CHANGELOG.md integration - Automated release notes - Post-release actions guide All commands provide: - Step-by-step guidance - Copy-paste ready commands - Validation checks - Error handling - Links to documentation Integration with workflows: - Commands trigger bootstrap, pr-into-dev, dev-to-main, release workflows - Enforces quality gates and conventions - Aligns with branching strategy Next: Test workflows with sample feature PR * fix(ci): handle multi-line PR body in linked issues check Use heredoc to safely write PR body to temp file instead of storing in variable. This prevents bash from interpreting special characters and multi-line content as commands (exit code 127 error). Fixes workflow failure in PR #3. * fix(ci): skip interactive scripts in bash syntax validation Interactive scripts that use /dev/tty for user input trigger false positives in bash -n syntax checking. This change: - Excludes install.sh from bash validation - Skips any script containing /dev/tty - Fixes quality gates failure in PR workflows Resolves quality gates failure in PR #5. * release: CI/CD system v1.1.0 * fix(ci): handle multi-line PR body in linked issues check Use heredoc to safely write PR body to temp file instead of storing in variable. This prevents bash from interpreting special characters and multi-line content as commands (exit code 127 error). Fixes workflow failure in PR #3. * fix(ci): skip interactive scripts in bash syntax validation Interactive scripts that use /dev/tty for user input trigger false positives in bash -n syntax checking. This change: - Excludes install.sh from bash validation - Skips any script containing /dev/tty - Fixes quality gates failure in PR workflows Resolves quality gates failure in PR #5. * feat(docs): validate multi-line PR body fix in workflows (#5) * feat(docs): add CI/CD fix validation documentation * chore: trigger workflow with updated quality gates * fix(ci): exclude docs from secret scanning and skip interactive script validation - Security checks: Exclude docs/ and examples/ from secret pattern matching (prevents false positives on documentation examples) - Install validation: Skip bash -n check for scripts using /dev/tty (interactive scripts are valid but fail non-interactive syntax checking) Fixes workflow failures in dev-to-main PRs. * fix(ci): skip bash -n check for install.sh in validate workflow Interactive script with /dev/tty cannot be syntax-checked non-interactively. * chore(release): merge dev into main - CI fixes and workflow improvements (#16) * fix(ci): handle multi-line PR body in linked issues check Use heredoc to safely write PR body to temp file instead of storing in variable. This prevents bash from interpreting special characters and multi-line content as commands (exit code 127 error). Fixes workflow failure in PR #3. * fix(ci): skip interactive scripts in bash syntax validation Interactive scripts that use /dev/tty for user input trigger false positives in bash -n syntax checking. This change: - Excludes install.sh from bash validation - Skips any script containing /dev/tty - Fixes quality gates failure in PR workflows Resolves quality gates failure in PR #5. * feat(docs): validate multi-line PR body fix in workflows (#5) * feat(docs): add CI/CD fix validation documentation * chore: trigger workflow with updated quality gates * fix(ci): exclude docs from secret scanning and skip interactive script validation - Security checks: Exclude docs/ and examples/ from secret pattern matching (prevents false positives on documentation examples) - Install validation: Skip bash -n check for scripts using /dev/tty (interactive scripts are valid but fail non-interactive syntax checking) Fixes workflow failures in dev-to-main PRs. * fix(ci): skip bash -n check for install.sh in validate workflow Interactive script with /dev/tty cannot be syntax-checked non-interactively.
96 lines
2.5 KiB
Markdown
96 lines
2.5 KiB
Markdown
---
|
|
title: /github-init
|
|
description: Initialize ClaudeForge CI/CD system
|
|
---
|
|
|
|
# GitHub CI/CD Initialization
|
|
|
|
You are helping the user initialize the ClaudeForge CI/CD system.
|
|
|
|
## Workflow
|
|
|
|
1. **Check Current State**
|
|
- Verify `.github/workflows/` directory exists
|
|
- Check if bootstrap workflow has been run (look for labels/milestones)
|
|
- Check if dev branch exists
|
|
- Check branch protection status
|
|
|
|
2. **Run Bootstrap Workflow**
|
|
- If not yet run, guide user to run bootstrap workflow:
|
|
- Go to Actions → Bootstrap Repository → Run workflow
|
|
- Enable all options (create labels, milestones, validate settings)
|
|
- Explain what will be created (23 labels, 3 milestones)
|
|
|
|
3. **Create Dev Branch** (if not exists)
|
|
```bash
|
|
git checkout -b dev
|
|
git push -u origin dev
|
|
```
|
|
|
|
4. **Configure Branch Protection**
|
|
|
|
Guide user step-by-step:
|
|
|
|
**For main branch:**
|
|
- Go to Settings → Branches → Add rule
|
|
- Pattern: `main`
|
|
- Enable:
|
|
- Require PR before merging
|
|
- Require status checks: `quality-gates`, `production-build`, `validate-release-pr`
|
|
- Require linear history
|
|
- Block force pushes
|
|
- Restrict deletions
|
|
|
|
**For dev branch:**
|
|
- Pattern: `dev`
|
|
- Enable:
|
|
- Require PR before merging
|
|
- Require status checks: `quality-gates`, `validate-pr`
|
|
- Require linear history
|
|
- Block force pushes
|
|
- Restrict deletions
|
|
|
|
5. **Set Default Branch**
|
|
- Settings → General → Default branch → Change to `dev`
|
|
- This ensures new PRs target dev by default
|
|
|
|
6. **Verification**
|
|
- Show current branch protection rules
|
|
- Verify workflows are present
|
|
- Confirm setup is complete
|
|
|
|
7. **Next Steps**
|
|
- Point to docs/GITHUB_WORKFLOWS.md for workflow reference
|
|
- Point to docs/BRANCHING_STRATEGY.md for branch flow
|
|
- Suggest creating first feature branch to test
|
|
|
|
## Commands to provide
|
|
|
|
```bash
|
|
# Check current setup
|
|
gh repo view --json name,defaultBranchRef,hasIssuesEnabled
|
|
|
|
# List workflows
|
|
ls -la .github/workflows/
|
|
|
|
# Check labels
|
|
gh label list
|
|
|
|
# Check milestones
|
|
gh api repos/:owner/:repo/milestones
|
|
|
|
# Check branch protection
|
|
gh api repos/:owner/:repo/branches/main/protection 2>/dev/null || echo "Not protected"
|
|
gh api repos/:owner/:repo/branches/dev/protection 2>/dev/null || echo "Not protected"
|
|
```
|
|
|
|
## Success Criteria
|
|
|
|
✅ Bootstrap workflow run successfully
|
|
✅ Dev branch created and pushed
|
|
✅ Branch protection configured for main and dev
|
|
✅ Default branch set to dev
|
|
✅ User understands next steps
|
|
|
|
Provide clear, step-by-step guidance with actual commands the user can copy-paste.
|