roadmap-cli 0.1.1__py3-none-any.whl

roadmap/templates/github_workflows/ci-cd-roadmap.yml

@@ -0,0 +1,241 @@
+# Advanced CI/CD with Roadmap Validation
+# Comprehensive testing and roadmap compliance checking
+
+name: 🚀 CI/CD with Roadmap Validation
+
+on:
+  push:
+    branches: [ main, master, develop, 'feature/**', 'bugfix/**' ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+env:
+  PYTHON_VERSION: '3.11'
+  ROADMAP_VALIDATE: true
+
+jobs:
+  # Job 1: Code Quality & Testing
+  test-and-validate:
+    runs-on: ubuntu-latest
+    name: 🧪 Test & Validate Code
+
+    steps:
+    - name: 📥 Checkout Code
+      uses: actions/checkout@v4
+
+    - name: 🐍 Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: 📦 Install Dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -e .
+        pip install pytest pytest-cov black flake8
+
+    - name: 🎨 Code Formatting Check
+      run: |
+        echo "🎨 Checking code formatting with Black..."
+        black --check . || (echo "❌ Code formatting issues found. Run 'black .' to fix." && exit 1)
+
+    - name: 🔍 Lint Code
+      run: |
+        echo "🔍 Linting code with flake8..."
+        flake8 --max-line-length=88 --ignore=E203,W503 . || echo "⚠️ Linting issues found"
+
+    - name: 🧪 Run Tests
+      run: |
+        echo "🧪 Running test suite..."
+        pytest --cov=roadmap --cov-report=xml --cov-report=term-missing -v
+
+    - name: 📊 Upload Coverage
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+
+  # Job 2: Roadmap Compliance Check
+  roadmap-compliance:
+    runs-on: ubuntu-latest
+    name: 🗺️ Roadmap Compliance
+    needs: test-and-validate
+
+    steps:
+    - name: 📥 Checkout Code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: 🐍 Setup Python & Roadmap
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: 📦 Install Roadmap CLI
+      run: |
+        pip install --upgrade pip
+        pip install -e .
+
+    - name: 🔍 Validate Branch Naming
+      if: github.event_name == 'pull_request'
+      run: |
+        BRANCH_NAME="${{ github.head_ref }}"
+        echo "🌿 Validating branch name: $BRANCH_NAME"
+
+        # Check if branch follows roadmap conventions
+        if [[ $BRANCH_NAME =~ ^(feature|bugfix|hotfix)/[a-f0-9]{8}- ]]; then
+          echo "✅ Branch follows roadmap naming convention"
+
+          # Extract issue ID and validate it exists
+          ISSUE_ID=$(echo "$BRANCH_NAME" | grep -o '[a-f0-9]\{8\}' | head -1)
+          echo "🎯 Found issue ID: $ISSUE_ID"
+
+          # Check if issue exists (will create validation command)
+          roadmap ci track-branch "$BRANCH_NAME" || echo "⚠️ Issue validation skipped"
+        else
+          echo "ℹ️  Branch doesn't follow roadmap convention (feature/issue-id-description)"
+          echo "💡 Consider: feature/12345678-add-new-feature"
+        fi
+
+    - name: 🔍 Scan for Issue References
+      run: |
+        echo "🔍 Scanning commits for issue references..."
+
+        # Scan recent commits for roadmap integration
+        COMMITS_TO_SCAN=10
+        if [ "${{ github.event_name }}" == "pull_request" ]; then
+          COMMITS_TO_SCAN=50  # Scan more commits for PRs
+        fi
+
+        roadmap ci scan-repository --max-commits $COMMITS_TO_SCAN
+
+        # Show current tracking status
+        echo "📊 Current CI tracking status:"
+        roadmap ci status
+
+    - name: 📋 Generate Roadmap Report
+      run: |
+        echo "📋 Generating comprehensive roadmap report..."
+
+        # Create detailed status report
+        {
+          echo "# 🗺️ Roadmap Status Report"
+          echo "**Generated**: $(date)"
+          echo "**Branch**: ${{ github.ref_name }}"
+          echo "**Commit**: ${{ github.sha }}"
+          echo ""
+          echo "## 📊 Overall Status"
+          roadmap status || echo "Status unavailable"
+          echo ""
+          echo "## 🎯 Active Issues"
+          roadmap issue list --status todo,in-progress || echo "Issue list unavailable"
+          echo ""
+          echo "## 🚀 Milestone Progress"
+          roadmap milestone list || echo "Milestone list unavailable"
+          echo ""
+          echo "## 🔧 CI/CD Integration Status"
+          roadmap ci status || echo "CI status unavailable"
+        } > roadmap-report.md
+
+        # Show report
+        cat roadmap-report.md
+
+    - name: 💬 Comment Roadmap Status on PR
+      if: github.event_name == 'pull_request'
+      uses: actions/github-script@v7
+      with:
+        script: |
+          const fs = require('fs');
+
+          // Read the roadmap report
+          let report = '📋 Roadmap status report not available';
+          try {
+            report = fs.readFileSync('roadmap-report.md', 'utf8');
+          } catch (error) {
+            console.log('Could not read roadmap report:', error.message);
+          }
+
+          // Create or update comment
+          const { data: comments } = await github.rest.issues.listComments({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: context.issue.number,
+          });
+
+          const botComment = comments.find(comment =>
+            comment.user.type === 'Bot' &&
+            comment.body.includes('🗺️ Roadmap Status Report')
+          );
+
+          const commentBody = `🗺️ **Roadmap Status Report**
+
+          <details>
+          <summary>📊 Click to view detailed roadmap status</summary>
+
+          ${report}
+
+          </details>
+
+          ---
+          🤖 *This report is automatically generated by the roadmap integration system.*
+          `;
+
+          if (botComment) {
+            // Update existing comment
+            await github.rest.issues.updateComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: botComment.id,
+              body: commentBody
+            });
+          } else {
+            // Create new comment
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              body: commentBody
+            });
+          }
+
+  # Job 3: Deploy/Release (if on main branch)
+  deploy:
+    runs-on: ubuntu-latest
+    name: 🚀 Deploy & Release
+    needs: [test-and-validate, roadmap-compliance]
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
+
+    steps:
+    - name: 📥 Checkout Code
+      uses: actions/checkout@v4
+
+    - name: 🎉 Mark Milestone Progress
+      run: |
+        echo "🎉 Main branch updated! Checking for milestone completion..."
+
+        # Install roadmap CLI
+        pip install --upgrade pip
+        pip install -e .
+
+        # Update milestone progress based on completed issues
+        roadmap recalculate-progress || echo "Progress recalculation skipped"
+
+        echo "📊 Current milestone status:"
+        roadmap milestone list || echo "Milestone list unavailable"
+
+    - name: 📦 Build Package (if applicable)
+      run: |
+        echo "📦 Building package for potential release..."
+        # Add your build steps here
+        # python -m build
+        # npm run build
+        # etc.
+
+    - name: 🏷️ Create Release (if version tagged)
+      if: startsWith(github.ref, 'refs/tags/v')
+      run: |
+        echo "🏷️ Version tag detected: ${{ github.ref_name }}"
+        echo "🚀 Release process would be triggered here"
+        # Add release automation here

roadmap/templates/github_workflows/issue-lifecycle.yml

@@ -0,0 +1,236 @@
+# Issue Lifecycle Automation
+# Advanced workflow for managing issue states based on git activity
+
+name: 🎯 Issue Lifecycle Management
+
+on:
+  push:
+    branches: [ main, master, develop, 'feature/**', 'hotfix/**', 'bugfix/**' ]
+  pull_request:
+    types: [ opened, synchronize, ready_for_review, closed ]
+  create:
+    # Trigger when branches are created
+  delete:
+    # Trigger when branches are deleted
+
+env:
+  ROADMAP_AUTO_TRANSITIONS: true
+  ROADMAP_DEPENDENCY_CHECKING: true
+
+jobs:
+  issue-lifecycle:
+    runs-on: ubuntu-latest
+    name: 🔄 Manage Issue Lifecycle
+
+    steps:
+    - name: 📥 Checkout Repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: 🐍 Setup Environment
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: 📦 Install Roadmap CLI
+      run: |
+        pip install --upgrade pip
+        pip install -e .
+
+    - name: 🌿 Handle Branch Creation
+      if: github.event_name == 'create' && github.event.ref_type == 'branch'
+      run: |
+        BRANCH_NAME="${{ github.event.ref }}"
+        echo "🌿 New branch created: $BRANCH_NAME"
+
+        # Extract issue ID from branch name
+        if [[ $BRANCH_NAME =~ ([a-f0-9]{8}) ]]; then
+          ISSUE_ID="${BASH_REMATCH[1]}"
+          echo "🎯 Found issue ID: $ISSUE_ID"
+
+          # Track branch creation and potentially start issue
+          roadmap ci track-branch "$BRANCH_NAME"
+
+          echo "✅ Issue $ISSUE_ID associated with branch $BRANCH_NAME"
+        else
+          echo "ℹ️  Branch doesn't follow issue naming convention"
+        fi
+
+    - name: 🗑️ Handle Branch Deletion
+      if: github.event_name == 'delete' && github.event.ref_type == 'branch'
+      run: |
+        BRANCH_NAME="${{ github.event.ref }}"
+        echo "🗑️  Branch deleted: $BRANCH_NAME"
+
+        # Clean up branch associations (but preserve commit history)
+        echo "🧹 Cleaning up branch associations..."
+        # Note: We'll implement branch cleanup in CI commands
+
+    - name: 📝 Handle Commit Activity
+      if: github.event_name == 'push'
+      run: |
+        echo "📝 Processing commits from push event..."
+
+        # Get list of new commits
+        COMMITS=$(git log --format="%H" ${{ github.event.before }}..${{ github.event.after }})
+
+        for COMMIT in $COMMITS; do
+          echo "🔍 Processing commit: $COMMIT"
+
+          # Track commit and extract issue associations
+          RESULT=$(roadmap ci track-commit "$COMMIT")
+          echo "$RESULT"
+
+          # Check for progress updates or completion markers
+          COMMIT_MSG=$(git log -1 --format="%s" "$COMMIT")
+          echo "📄 Message: $COMMIT_MSG"
+
+          # Look for dependency updates or blockers
+          if [[ $COMMIT_MSG =~ (unblock|depends|blocks) ]]; then
+            echo "🔗 Dependency-related commit detected"
+            # Future: Handle dependency resolution
+          fi
+        done
+
+    - name: 🔀 Handle Pull Request Events
+      if: github.event_name == 'pull_request'
+      run: |
+        PR_NUMBER="${{ github.event.number }}"
+        PR_ACTION="${{ github.event.action }}"
+        PR_TITLE="${{ github.event.pull_request.title }}"
+        PR_BRANCH="${{ github.event.pull_request.head.ref }}"
+
+        echo "🔀 PR Event: #$PR_NUMBER ($PR_ACTION)"
+        echo "📝 Title: $PR_TITLE"
+        echo "🌿 Branch: $PR_BRANCH"
+
+        case "$PR_ACTION" in
+          "opened"|"ready_for_review")
+            echo "🎯 PR opened - checking for issue associations..."
+
+            # Extract issue IDs from PR branch, title, and body
+            PR_TEXT="$PR_TITLE ${{ github.event.pull_request.body }}"
+
+            # Track PR and associate with issues
+            roadmap ci track-pr \
+              --number "$PR_NUMBER" \
+              --title "$PR_TITLE" \
+              --branch "$PR_BRANCH" \
+              --state "open"
+
+            echo "✅ PR tracked in roadmap system"
+            ;;
+
+          "synchronize")
+            echo "🔄 PR updated - scanning new commits..."
+
+            # Get new commits in PR
+            git fetch origin "$PR_BRANCH"
+            NEW_COMMITS=$(git log --format="%H" HEAD..origin/$PR_BRANCH)
+
+            for COMMIT in $NEW_COMMITS; do
+              roadmap ci track-commit "$COMMIT"
+            done
+            ;;
+
+          "closed")
+            if [[ "${{ github.event.pull_request.merged }}" == "true" ]]; then
+              echo "🎉 PR merged! Processing completion logic..."
+
+              # Handle merged PR - potential issue completion
+              roadmap ci track-pr \
+                --number "$PR_NUMBER" \
+                --title "$PR_TITLE" \
+                --branch "$PR_BRANCH" \
+                --state "merged"
+
+              # Scan merged commits for completion markers
+              echo "🔍 Scanning merged commits for issue completion..."
+              roadmap ci scan-repository --max-commits 20
+
+            else
+              echo "❌ PR closed without merge"
+              roadmap ci track-pr \
+                --number "$PR_NUMBER" \
+                --title "$PR_TITLE" \
+                --branch "$PR_BRANCH" \
+                --state "closed"
+            fi
+            ;;
+        esac
+
+    - name: 🎯 Update Issue States
+      run: |
+        echo "🎯 Checking for automated issue state transitions..."
+
+        # Get current branch (for push events)
+        if [ "${{ github.event_name }}" == "push" ]; then
+          CURRENT_BRANCH="${{ github.ref_name }}"
+          echo "📍 Current branch: $CURRENT_BRANCH"
+
+          # Auto-transition issues based on branch activity
+          if [[ $CURRENT_BRANCH =~ ^(feature|bugfix|hotfix)/ ]]; then
+            echo "🔄 Feature branch activity - checking issue states..."
+            roadmap ci track-branch "$CURRENT_BRANCH"
+          fi
+        fi
+
+    - name: 📊 Generate Activity Summary
+      run: |
+        echo "📊 Generating issue activity summary..."
+
+        {
+          echo "# 🎯 Issue Activity Summary"
+          echo "**Event**: ${{ github.event_name }}"
+          echo "**Repository**: ${{ github.repository }}"
+          echo "**Timestamp**: $(date -u '+%Y-%m-%d %H:%M:%S UTC')"
+          echo ""
+
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            echo "**PR**: #${{ github.event.number }} - ${{ github.event.pull_request.title }}"
+            echo "**Branch**: ${{ github.event.pull_request.head.ref }}"
+            echo "**Action**: ${{ github.event.action }}"
+            echo ""
+          fi
+
+          echo "## 🔄 Recent Activity"
+          roadmap activity --limit 5 || echo "Activity log unavailable"
+
+          echo ""
+          echo "## 🎯 Active Issues"
+          roadmap issue list --status in-progress || echo "No active issues"
+
+          echo ""
+          echo "## 🏁 Recently Completed"
+          roadmap issue list --status done --limit 3 || echo "No recent completions"
+
+        } > activity-summary.md
+
+        echo "📋 Activity Summary Generated:"
+        cat activity-summary.md
+
+    - name: 📈 Update Metrics
+      run: |
+        echo "📈 Updating project metrics..."
+
+        # Recalculate progress for milestones
+        roadmap recalculate-progress
+
+        # Show updated status
+        echo "📊 Updated project status:"
+        roadmap status
+
+        echo "🏆 Milestone progress:"
+        roadmap milestone list
+
+    - name: 🚨 Check for Blockers
+      run: |
+        echo "🚨 Checking for blocked issues or dependencies..."
+
+        # Future enhancement: dependency resolution
+        echo "🔍 Dependency checking (future feature)"
+
+        # Check for overdue items
+        echo "⏰ Checking for overdue items..."
+        roadmap milestone list | grep -E "(overdue|late)" || echo "✅ No overdue items detected"

roadmap/templates/github_workflows/roadmap-integration.yml

@@ -0,0 +1,137 @@
+# Roadmap Integration Workflow
+# Automatically tracks issues and updates roadmap based on git activity
+
+name: 🗺️ Roadmap Integration
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+    types: [ opened, synchronize, closed ]
+  workflow_dispatch:
+
+env:
+  ROADMAP_AUTO_TRACK: true
+  ROADMAP_PROGRESS_TRACKING: true
+
+jobs:
+  roadmap-tracking:
+    runs-on: ubuntu-latest
+    name: Track Roadmap Changes
+
+    steps:
+    - name: 📥 Checkout Repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Full history for comprehensive tracking
+
+    - name: 🐍 Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: 📦 Install Roadmap CLI
+      run: |
+        pip install --upgrade pip
+        # Install from PyPI when published, for now install locally
+        pip install -e .
+
+    - name: 🔍 Initialize Roadmap (if needed)
+      run: |
+        if [ ! -f ".roadmap/config.yaml" ]; then
+          echo "Initializing roadmap for CI/CD tracking..."
+          roadmap init --name "${{ github.repository }}" --auto-confirm
+        fi
+
+    - name: 🎯 Track Commit Changes
+      if: github.event_name == 'push'
+      run: |
+        echo "🔍 Scanning recent commits for roadmap updates..."
+        roadmap ci scan-repository --max-commits 10
+
+        # Track specific commits in this push
+        for commit in $(git log --format="%H" ${{ github.event.before }}..${{ github.event.after }}); do
+          echo "📝 Tracking commit: $commit"
+          roadmap ci track-commit "$commit" || true
+        done
+
+    - name: 🔀 Track Pull Request
+      if: github.event_name == 'pull_request'
+      run: |
+        echo "🔍 Tracking PR #${{ github.event.number }}: ${{ github.event.pull_request.title }}"
+
+        # Extract issue IDs from PR title and body
+        PR_TEXT="${{ github.event.pull_request.title }} ${{ github.event.pull_request.body }}"
+
+        # Track PR association
+        roadmap ci track-pr \
+          --number "${{ github.event.number }}" \
+          --title "${{ github.event.pull_request.title }}" \
+          --branch "${{ github.event.pull_request.head.ref }}" \
+          --state "${{ github.event.pull_request.state }}" || true
+
+    - name: ✅ Handle PR Merge
+      if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
+      run: |
+        echo "🎉 PR #${{ github.event.number }} merged! Processing completion..."
+
+        # Scan merged commits for completion
+        roadmap ci scan-repository --max-commits 5
+
+        # Mark associated issues as potentially complete
+        echo "🏁 Checking for issue completion in merged PR..."
+
+    - name: 📊 Generate Roadmap Status Report
+      run: |
+        echo "📈 Current roadmap status:"
+        roadmap status || true
+
+        echo "🔧 CI/CD tracking status:"
+        roadmap ci status || true
+
+        echo "📋 Recent activity:"
+        roadmap activity || true
+
+    - name: 💾 Commit Roadmap Updates
+      if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action == 'closed')
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "Roadmap Integration"
+
+        # Check if there are changes to commit
+        if git diff --quiet HEAD -- .roadmap/; then
+          echo "📝 No roadmap changes to commit"
+        else
+          echo "💾 Committing roadmap updates..."
+          git add .roadmap/
+          git commit -m "🤖 Auto-update roadmap from CI/CD tracking
+
+          - Processed commits from ${{ github.event_name }} event
+          - Updated issue associations and progress
+          - Automated via GitHub Actions" || true
+
+          # Push changes back to repository
+          git push || echo "⚠️  Could not push roadmap updates (may need write permissions)"
+        fi
+
+    - name: 📝 Comment on PR (if applicable)
+      if: github.event_name == 'pull_request' && github.event.action == 'opened'
+      uses: actions/github-script@v7
+      with:
+        script: |
+          // Add a comment with roadmap integration info
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: `🗺️ **Roadmap Integration**
+
+            This PR has been automatically tracked by the roadmap system.
+
+            - 🔍 **Branch analysis**: Scanning for issue associations
+            - 📊 **Progress tracking**: Monitoring commit progress markers
+            - 🎯 **Auto-completion**: Will process completion on merge
+
+            Use commit messages like \`[progress:50%]\` or \`[closes roadmap:issue-id]\` for automatic updates!`
+          });

roadmap/templates/github_workflows/roadmap-starter.yml

@@ -0,0 +1,59 @@
+# Simple Roadmap Starter Workflow
+# Basic integration for projects just getting started with roadmap
+
+name: 🌱 Roadmap Starter
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  roadmap-basics:
+    runs-on: ubuntu-latest
+    name: 🗺️ Basic Roadmap Integration
+
+    steps:
+    - name: 📥 Checkout Repository
+      uses: actions/checkout@v4
+
+    - name: 🐍 Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: 📦 Install Roadmap CLI
+      run: |
+        pip install --upgrade pip
+        # TODO: Replace with actual PyPI package when published
+        pip install roadmap-cli
+
+    - name: 🎯 Track Recent Changes
+      run: |
+        echo "🔍 Scanning for roadmap-related changes..."
+
+        # Initialize roadmap if needed
+        if [ ! -f ".roadmap/config.yaml" ]; then
+          echo "🚀 First time setup - initializing roadmap..."
+          roadmap init --name "${{ github.repository }}" --auto-confirm
+        fi
+
+        # Track recent commits
+        roadmap ci scan-repository --max-commits 5
+
+        # Show current status
+        echo "📊 Current roadmap status:"
+        roadmap status
+
+    - name: ✅ Validate Setup
+      run: |
+        echo "✅ Roadmap integration validated!"
+        echo "🎉 Your project is now integrated with roadmap tracking."
+        echo ""
+        echo "💡 Next steps:"
+        echo "  - Use issue IDs in branch names: feature/12345678-new-feature"
+        echo "  - Add progress markers: git commit -m 'Fix bug [progress:50%]'"
+        echo "  - Mark completion: git commit -m 'Done [closes roadmap:12345678]'"
+        echo ""
+        echo "📚 Learn more: https://github.com/roadmap-cli/roadmap"