gem-ci 0.2.1 → 0.4.0

data/scripts/test-workflows

@@ -0,0 +1,303 @@
+#!/usr/bin/env bash
+# gem-ci Workflow Tests Runner
+# Run all validation tests in .github/workflows/tests/
+
+set -euo pipefail
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Configuration
+TESTS_DIR=".github/workflows/tests"
+SECRETS_FILE=".secrets"
+RUNNER_IMAGE="catthehacker/ubuntu:act-latest"
+
+# Display usage information
+usage() {
+    cat << EOF
+${BLUE}gem-ci Workflow Tests Runner${NC}
+
+Usage: ./scripts/test-workflows [OPTIONS]
+
+${YELLOW}Options:${NC}
+  -h, --help        Show this help message
+  -v, --verbose     Enable verbose output
+  -l, --list        List available test workflows
+  -t, --test TEST   Run specific test workflow
+  -s, --setup       Check setup and requirements
+  --no-secrets      Run without secrets file
+  --runner IMAGE    Use specific runner image
+
+${YELLOW}Available Tests:${NC}
+  github-app        Test GitHub App authentication
+  labels-sync       Test labels synchronization
+  slack-integration Test Slack integration
+  repository-rules  Test repository rulesets
+
+${YELLOW}Examples:${NC}
+  ./scripts/test-workflows                           # Run all tests
+  ./scripts/test-workflows -t github-app             # Run specific test
+  ./scripts/test-workflows --list                    # List available tests
+  ./scripts/test-workflows --setup                   # Check setup
+  ./scripts/test-workflows -v                        # Verbose output
+
+${YELLOW}Setup:${NC}
+  1. Copy secrets: cp .secrets.example .secrets
+  2. Edit secrets: nano .secrets
+  3. Run tests: ./scripts/test-workflows
+
+EOF
+}
+
+# Check if act is installed
+check_act() {
+    if ! command -v act &> /dev/null; then
+        echo -e "${RED}Error: 'act' is not installed${NC}"
+        echo "Install with: brew install act"
+        echo "Or see: https://nektosact.com/installation/"
+        exit 1
+    fi
+}
+
+# Check if Docker is running
+check_docker() {
+    if ! docker info &> /dev/null; then
+        echo -e "${RED}Error: Docker is not running${NC}"
+        echo "Please start Docker and try again"
+        exit 1
+    fi
+}
+
+# Check setup requirements
+check_setup() {
+    echo -e "${BLUE}Checking setup requirements...${NC}"
+    
+    # Check act
+    if command -v act &> /dev/null; then
+        echo -e "${GREEN}✓${NC} act is installed ($(act --version))"
+    else
+        echo -e "${RED}✗${NC} act is not installed"
+        return 1
+    fi
+    
+    # Check Docker
+    if docker info &> /dev/null; then
+        echo -e "${GREEN}✓${NC} Docker is running"
+    else
+        echo -e "${RED}✗${NC} Docker is not running"
+        return 1
+    fi
+    
+    # Check tests directory
+    if [[ -d "$TESTS_DIR" ]]; then
+        local test_count=$(find "$TESTS_DIR" -name "*.yml" | wc -l)
+        echo -e "${GREEN}✓${NC} Found $test_count test workflow files in $TESTS_DIR"
+    else
+        echo -e "${RED}✗${NC} Tests directory not found: $TESTS_DIR"
+        return 1
+    fi
+    
+    # Check secrets file
+    if [[ -f "$SECRETS_FILE" ]]; then
+        echo -e "${GREEN}✓${NC} Secrets file exists ($SECRETS_FILE)"
+    else
+        echo -e "${YELLOW}!${NC} Secrets file not found ($SECRETS_FILE)"
+        echo "  Copy example: cp .secrets.example .secrets"
+    fi
+    
+    echo -e "${GREEN}Setup check complete!${NC}"
+}
+
+# List available test workflows
+list_tests() {
+    echo -e "${BLUE}Available test workflows:${NC}"
+    
+    if [[ ! -d "$TESTS_DIR" ]]; then
+        echo -e "${RED}Error: Tests directory not found: $TESTS_DIR${NC}"
+        exit 1
+    fi
+    
+    local tests=()
+    while IFS= read -r -d '' file; do
+        local basename=$(basename "$file" .yml)
+        local name=$(echo "$basename" | sed 's/validate-//' | sed 's/-/ /g')
+        tests+=("$basename:$name")
+    done < <(find "$TESTS_DIR" -name "validate-*.yml" -print0 | sort -z)
+    
+    if [[ ${#tests[@]} -eq 0 ]]; then
+        echo -e "${YELLOW}No test workflows found in $TESTS_DIR${NC}"
+        return
+    fi
+    
+    for test in "${tests[@]}"; do
+        IFS=':' read -r basename name <<< "$test"
+        echo -e "  ${GREEN}$basename${NC} - $name"
+    done
+}
+
+# Build act command with common options
+build_act_command() {
+    local cmd="act"
+    
+    # Add runner image
+    cmd="$cmd -P ubuntu-latest=$RUNNER_IMAGE"
+    
+    # Add secrets file if it exists and not disabled
+    if [[ "$USE_SECRETS" == "true" && -f "$SECRETS_FILE" ]]; then
+        cmd="$cmd --secret-file $SECRETS_FILE"
+    fi
+    
+    # Add verbose flag if requested
+    if [[ "$VERBOSE" == "true" ]]; then
+        cmd="$cmd -v"
+    fi
+    
+    echo "$cmd"
+}
+
+# Run specific test workflow
+run_test() {
+    local test_name="$1"
+    local workflow_file="$TESTS_DIR/validate-$test_name.yml"
+    
+    if [[ ! -f "$workflow_file" ]]; then
+        echo -e "${RED}Error: Test workflow not found: $workflow_file${NC}"
+        echo "Available tests:"
+        list_tests
+        exit 1
+    fi
+    
+    echo -e "${BLUE}Running test: $test_name${NC}"
+    local cmd=$(build_act_command)
+    cmd="$cmd -W $workflow_file"
+    
+    echo -e "${YELLOW}Command: $cmd${NC}"
+    
+    if eval "$cmd"; then
+        echo -e "${GREEN}✓ Test passed: $test_name${NC}"
+        return 0
+    else
+        echo -e "${RED}✗ Test failed: $test_name${NC}"
+        return 1
+    fi
+}
+
+# Run all test workflows
+run_all_tests() {
+    echo -e "${BLUE}Running all workflow tests...${NC}"
+    
+    if [[ ! -d "$TESTS_DIR" ]]; then
+        echo -e "${RED}Error: Tests directory not found: $TESTS_DIR${NC}"
+        exit 1
+    fi
+    
+    local tests=()
+    while IFS= read -r -d '' file; do
+        local basename=$(basename "$file" .yml)
+        local test_name=$(echo "$basename" | sed 's/validate-//')
+        tests+=("$test_name")
+    done < <(find "$TESTS_DIR" -name "validate-*.yml" -print0 | sort -z)
+    
+    if [[ ${#tests[@]} -eq 0 ]]; then
+        echo -e "${YELLOW}No test workflows found in $TESTS_DIR${NC}"
+        exit 0
+    fi
+    
+    local passed=0
+    local failed=0
+    local failed_tests=()
+    
+    echo -e "${BLUE}Found ${#tests[@]} test workflows${NC}"
+    
+    for test in "${tests[@]}"; do
+        echo -e "\n${BLUE}Running test: $test${NC}"
+        
+        if run_test "$test"; then
+            ((passed++))
+        else
+            ((failed++))
+            failed_tests+=("$test")
+        fi
+    done
+    
+    # Summary
+    echo -e "\n${BLUE}Test Results Summary:${NC}"
+    echo -e "${GREEN}✓ Passed: $passed${NC}"
+    echo -e "${RED}✗ Failed: $failed${NC}"
+    echo -e "Total: ${#tests[@]}"
+    
+    if [[ $failed -gt 0 ]]; then
+        echo -e "\n${RED}Failed tests:${NC}"
+        for test in "${failed_tests[@]}"; do
+            echo -e "  - $test"
+        done
+        exit 1
+    else
+        echo -e "\n${GREEN}All tests passed!${NC}"
+    fi
+}
+
+# Main function
+main() {
+    # Default values
+    VERBOSE="false"
+    USE_SECRETS="true"
+    SPECIFIC_TEST=""
+    
+    # Parse arguments
+    while [[ $# -gt 0 ]]; do
+        case $1 in
+            -h|--help)
+                usage
+                exit 0
+                ;;
+            -v|--verbose)
+                VERBOSE="true"
+                shift
+                ;;
+            -l|--list)
+                list_tests
+                exit 0
+                ;;
+            -t|--test)
+                SPECIFIC_TEST="$2"
+                shift 2
+                ;;
+            -s|--setup)
+                check_setup
+                exit 0
+                ;;
+            --no-secrets)
+                USE_SECRETS="false"
+                shift
+                ;;
+            --runner)
+                RUNNER_IMAGE="$2"
+                shift 2
+                ;;
+            *)
+                echo -e "${RED}Error: Unknown option: $1${NC}"
+                echo "Use --help for usage information"
+                exit 1
+                ;;
+        esac
+    done
+    
+    # Check requirements
+    check_act
+    check_docker
+    
+    # Run specific test or all tests
+    if [[ -n "$SPECIFIC_TEST" ]]; then
+        run_test "$SPECIFIC_TEST"
+    else
+        run_all_tests
+    fi
+}
+
+# Run main function
+main "$@"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-ci
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Huy Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-26 00:00:00.000000000 Z
+date: 2025-07-27 00:00:00.000000000 Z
 dependencies: []
 description: A showcase repository demonstrating advanced CI/CD workflows, automated
   testing, security scanning, community management, and comprehensive automation for
@@ -19,18 +19,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".secrets.example"
+- ".slack/app-manifest.json"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- docs/MANUAL_WORKFLOW_TESTING.md
-- docs/SECRETS_SETUP_GUIDE.md
+- docs/_config.yml
 - docs/diagrams/ci-workflow-overview.md
+- docs/diagrams/gitflow-diagram.md
+- docs/guides/gitflow.md
+- docs/guides/local-testing.md
+- docs/index.md
+- docs/setup/github-pages.md
+- docs/setup/secrets.md
+- docs/workflows/overview.md
 - lib/gem_ci.rb
 - lib/gem_ci/version.rb
+- public/gem-ci-transparent-bg.png
+- public/gem-ci.jpeg
+- public/gem-ci.svg
+- scripts/README.md
+- scripts/test-local
+- scripts/test-workflows
 - sig/gem/ci.rbs
 homepage: https://github.com/patrick204nqh/gem-ci
 licenses:

data/docs/MANUAL_WORKFLOW_TESTING.md

@@ -1,190 +0,0 @@
-# 🧪 Manual Workflow Testing Guide
-
-This guide explains how to manually test and trigger gem-ci workflows for validation and troubleshooting.
-
-## 🚀 Manual Workflow Triggers
-
-### Main Workflows (01-08)
-
-Most main workflows trigger automatically on events, but some can be triggered manually:
-
-| Workflow | File | Manual Trigger | Purpose |
-|----------|------|----------------|---------|
-| 01 - Intake | `01-intake.yml` | ✅ Yes | Sync labels and configurations |
-| 02 - CI | `02-ci.yml` | ❌ Auto only | Push/PR testing |
-| 03 - Security | `03-security.yml` | ❌ Auto only | Security scans |
-| 04 - Quality | `04-quality.yml` | ❌ Auto only | Code quality checks |
-| 05 - Community | `05-community.yml` | ❌ Auto only | Stale management |
-| 06 - Release | `06-release.yml` | ❌ Auto only | Tag-based releases |
-| 07 - Ecosystem | `07-ecosystem.yml` | ❌ Auto only | Ecosystem checks |
-| 08 - Monitoring | `08-monitoring.yml` | ❌ Auto only | Scheduled monitoring |
-
-### Test Workflows
-
-All validation workflows support manual triggering:
-
-| Validation Workflow | Purpose | Required Secrets |
-|-------------------|---------|------------------|
-| `validate-github-app.yml` | Test GitHub App setup | `APP_ID`, `PRIVATE_KEY` |
-| `validate-slack-integration.yml` | Test Slack notifications | `APP_ID`, `PRIVATE_KEY`, `SLACK_BOT_TOKEN`, `SLACK_CHANNEL_ID` |
-| `validate-labels-sync.yml` | Test label synchronization | `APP_ID`, `PRIVATE_KEY` |
-| `validate-repository-rulesets.yml` | Test repository rulesets | `APP_ID`, `PRIVATE_KEY` |
-
-## 📋 How to Manually Trigger Workflows
-
-### Method 1: GitHub Web Interface
-
-1. **Navigate to Actions Tab**
-   - Go to your repository on GitHub
-   - Click the **"Actions"** tab
-
-2. **Select Workflow**
-   - Find the workflow you want to trigger
-   - Click on the workflow name
-
-3. **Run Workflow**
-   - Click **"Run workflow"** button
-   - Select branch (usually `main`)
-   - Click **"Run workflow"** to confirm
-
-### Method 2: GitHub CLI
-
-```bash
-# Install GitHub CLI if not already installed
-# https://cli.github.com/
-
-# Trigger a workflow manually
-gh workflow run "workflow-name.yml"
-
-# Examples:
-gh workflow run "01-intake.yml"
-gh workflow run "validate-github-app.yml"
-
-# Check workflow status
-gh run list --workflow="workflow-name.yml"
-```
-
-### Method 3: REST API
-
-```bash
-# Trigger workflow via API
-curl -X POST \
-  -H "Accept: application/vnd.github.v3+json" \
-  -H "Authorization: token YOUR_GITHUB_TOKEN" \
-  https://api.github.com/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID/dispatches \
-  -d '{"ref":"main"}'
-```
-
-## 🔍 Testing Checklist
-
-### Before Running Tests
-
-- [ ] All required secrets are configured
-- [ ] Repository has proper permissions
-- [ ] Configuration files exist (`.github/labels.yml`, etc.)
-- [ ] Branch protection rules are properly set
-
-### GitHub App Validation
-
-```bash
-# Run GitHub App validation
-gh workflow run "validate-github-app.yml"
-
-# Expected results:
-# ✅ Token generation successful
-# ✅ API access working
-# ✅ Branded bot identity confirmed
-```
-
-### Slack Integration Testing
-
-```bash
-# Run Slack integration test
-gh workflow run "validate-slack-integration.yml"
-
-# Expected results:
-# ✅ Basic message sent to Slack
-# ✅ Rich message blocks working
-# ✅ Bot appears with correct identity
-```
-
-### Labels Synchronization
-
-```bash
-# Run label sync validation
-gh workflow run "validate-labels-sync.yml"
-
-# Expected results:
-# ✅ Label configuration valid
-# ✅ All required labels present
-# ✅ Color scheme accessibility confirmed
-```
-
-## 📊 Monitoring Workflow Results
-
-### Check Workflow Status
-
-```bash
-# List recent workflow runs
-gh run list --limit 10
-
-# Get details of specific run
-gh run view RUN_ID
-
-# Download workflow logs
-gh run download RUN_ID
-```
-
-### Common Issues & Solutions
-
-| Issue | Solution |
-|-------|----------|
-| **Token generation failed** | Verify `APP_ID` and `PRIVATE_KEY` secrets |
-| **Slack message not sent** | Check `SLACK_BOT_TOKEN` and `SLACK_CHANNEL_ID` |
-| **Label sync failed** | Validate `.github/labels.yml` syntax |
-| **API rate limit exceeded** | Wait and retry, or use GitHub App token |
-| **Permission denied** | Verify GitHub App permissions and installation |
-
-## 🛠️ Troubleshooting
-
-### Debug Mode
-
-Enable debug logging by setting repository variables:
-- `ACTIONS_STEP_DEBUG`: `true`
-- `ACTIONS_RUNNER_DEBUG`: `true`
-
-### Secrets Validation
-
-Use the validation workflows to test each component:
-
-1. **Start with GitHub App validation** - This tests the foundation
-2. **Run Slack validation** - If notifications are needed
-3. **Test label sync** - For repository organization
-4. **Validate rulesets** - For branch protection
-
-### Common Workflow Patterns
-
-- **On Push**: Triggers CI, security, and quality workflows
-- **On PR**: Triggers testing and validation workflows  
-- **On Release**: Triggers release and notification workflows
-- **On Schedule**: Triggers monitoring and maintenance workflows
-- **Manual**: Triggers setup and validation workflows
-
-## 📞 Getting Help
-
-If workflows fail after following this guide:
-
-1. Check workflow logs in the Actions tab
-2. Verify all required secrets are set
-3. Review configuration files for syntax errors
-4. Test individual components using validation workflows
-5. Check GitHub App permissions and installation
-
-## 🔄 Regular Testing Schedule
-
-Recommended testing schedule:
-
-- **Weekly**: Run GitHub App validation
-- **Monthly**: Test Slack integration (if used)
-- **Before releases**: Run all validation workflows
-- **After configuration changes**: Test affected workflows