Skip to main content

Maintenance Automation Workflow Integration

Status: Active
Version: 1.0.0
Last Updated: 2026-01-05
Epic: Epic 7 - Codebase Maintenance and Review
Story: Story 4 - Maintenance Automation and Tooling
Task: E7:S04:T03 - Integrate automation with existing workflows
Related: Maintenance Automation Requirements, Maintenance Automation Scripts, Release Workflow, Update Kanban Workflow

Executive Summary​

This document defines the integration of maintenance automation with existing workflows in the AI Dev Kit project. It establishes integration points, patterns, and processes for seamlessly incorporating automation into Release Workflow (RW), Update Kanban Workflow (UKW), maintenance workflows, and CI/CD pipelines.

Key Principles:

  • Seamless Integration: Automation integrates naturally with existing workflows
  • Non-Blocking: Automation failures don't block workflow execution (except critical)
  • Actionable Feedback: Automation provides clear, actionable feedback
  • Configurable: Automation behavior is configurable per workflow

Integration Overview​

Workflow Integration Points​

  1. Release Workflow (RW) Integration

    • IDE issue detection in RW Step 9
    • Quality checks before commit
    • Dependency checks before release
    • Automation validation

  2. Update Kanban Workflow (UKW) Integration

    • Automated task creation from findings
    • Status updates based on automation results
    • Metrics updates in Kanban

  3. Maintenance Workflow Integration

    • Automated issue detection
    • Automated prioritization
    • Automated task creation
    • Automated progress tracking

  4. CI/CD Integration

    • Automated quality gates
    • Automated test execution
    • Automated dependency checks
    • Automated reporting

Release Workflow (RW) Integration​

RW Step 9: IDE-Flagged Issue Detection​

Current State:

  • RW Step 9 checks for IDE-flagged problems
  • Uses read_lints tool for IDE diagnostics
  • Errors block workflow, warnings/infos are non-blocking

Automation Integration:

  • Enhanced Detection: Use automation script for comprehensive issue detection
  • Automated Reporting: Generate issue reports automatically
  • Automated Prioritization: Apply prioritization framework automatically
  • Automated Task Creation: Create Kanban tasks for high-priority issues

Integration Pattern:

# In RW Step 9
def check_ide_issues():
    # Run automation script
    result = run_script('scripts/maintenance/ide_issues/detect_ide_issues.py')
    
    # Process results
    if result.has_errors():
        # Block workflow
        return False
    
    # Create tasks for warnings/infos
    if result.has_warnings():
        create_kanban_tasks(result.warnings)
    
    return True

RW Step 9.5: Changelog Maintenance (CMW)​

Current State:

  • CMW runs automatically when changelog threshold exceeded
  • CMW is deterministic and script-driven

Automation Integration:

  • Enhanced CMW: Additional automation for changelog maintenance
  • Automated Archival: Enhanced archival automation
  • Automated Validation: Enhanced validation automation

RW Step 10: Quality Checks​

New Integration Point:

  • Run automated quality checks before commit
  • Quality gates based on metrics
  • Quality reports in changelog

Integration Pattern:

# In RW Step 10 (enhanced)
def run_quality_checks():
    # Run quality automation
    result = run_script('scripts/maintenance/quality/run_quality_checks.py')
    
    # Check quality gates
    if not result.passes_quality_gates():
        # Warn but don't block (configurable)
        log_warning("Quality gates not met")
    
    return True

Update Kanban Workflow (UKW) Integration​

Automated Task Creation​

Integration Point:

  • UKW detects maintenance needs
  • Automation creates tasks automatically
  • Tasks use prioritization framework

Integration Pattern:

# In UKW
def create_maintenance_tasks():
    # Run automation to detect issues
    issues = run_script('scripts/maintenance/ide_issues/detect_ide_issues.py')
    
    # Create tasks for high-priority issues
    for issue in issues:
        if issue.priority >= HIGH_THRESHOLD:
            create_kanban_task(issue)

Automated Status Updates​

Integration Point:

  • Automation results update Kanban status
  • Quality metrics update Kanban metadata
  • Progress tracked automatically

Integration Pattern:

# In UKW
def update_kanban_status():
    # Get automation results
    quality_metrics = get_quality_metrics()
    
    # Update Kanban metadata
    update_kanban_metadata(quality_metrics)

Maintenance Workflow Integration​

IDE-Flagged Issues Workflow​

Automation Integration:

  • Automated Detection: Use automation script for issue detection
  • Automated Categorization: Automatically categorize issues
  • Automated Prioritization: Apply prioritization framework
  • Automated Task Creation: Create Kanban tasks automatically

Integration Pattern:

# In IDE-Flagged Issues Workflow
def detect_ide_issues():
    # Run automation
    issues = run_script('scripts/maintenance/ide_issues/detect_ide_issues.py')
    
    # Categorize and prioritize
    categorized = categorize_issues(issues)
    prioritized = prioritize_issues(categorized)
    
    # Create tasks
    for issue in prioritized:
        create_maintenance_task(issue)

Prioritized Maintenance Workflow​

Automation Integration:

  • Automated Assessment: Use automation for initial assessment
  • Automated Prioritization: Apply prioritization framework
  • Automated Tracking: Track progress automatically

Scheduled Maintenance Workflow​

Automation Integration:

  • Automated Scanning: Comprehensive automated scanning
  • Automated Batch Processing: Automated batch task creation
  • Automated Reporting: Automated maintenance reports

CI/CD Integration​

Quality Gates​

Integration Point:

  • Automated quality checks in CI/CD
  • Quality gates before merge
  • Quality reports in CI/CD

Integration Pattern:

# CI/CD configuration
quality_gates:
  - name: code_quality
    script: scripts/maintenance/quality/run_quality_checks.py
    threshold: 70
    blocking: true
  
  - name: test_coverage
    script: scripts/maintenance/quality/check_coverage.py
    threshold: 80
    blocking: false

Automated Testing​

Integration Point:

  • Automated test execution in CI/CD
  • Test results in CI/CD reports
  • Test coverage tracking

Dependency Checks​

Integration Point:

  • Automated dependency scanning in CI/CD
  • Vulnerability checks before merge
  • Update recommendations

Integration Patterns​

Pattern 1: Non-Blocking Automation​

Use Case: Quality checks, documentation validation

Pattern:

  • Run automation
  • Log results
  • Warn if issues found
  • Don't block workflow

Example:

def run_non_blocking_automation(script):
    result = run_script(script)
    if result.has_issues():
        log_warning(f"Issues found: {result.issues}")
    return True  # Always return True (non-blocking)

Pattern 2: Blocking Automation​

Use Case: Critical errors, security vulnerabilities

Pattern:

  • Run automation
  • Check for critical issues
  • Block workflow if critical issues found
  • Allow workflow to proceed otherwise

Example:

def run_blocking_automation(script):
    result = run_script(script)
    if result.has_critical_issues():
        log_error(f"Critical issues found: {result.critical_issues}")
        return False  # Block workflow
    return True

Pattern 3: Task Creation Automation​

Use Case: Issue detection, quality findings

Pattern:

  • Run automation
  • Process results
  • Create Kanban tasks
  • Update Kanban board

Example:

def create_tasks_from_automation(script):
    result = run_script(script)
    for finding in result.findings:
        if finding.priority >= THRESHOLD:
            create_kanban_task(finding)
    update_kanban_board()

Configuration​

Workflow Configuration​

Configuration File: rw-config.yaml (or workflow-specific config)

Configuration Options:

maintenance_automation:
  enabled: true
  ide_issues:
    enabled: true
    blocking: true  # Errors block, warnings don't
    create_tasks: true
  quality_checks:
    enabled: true
    blocking: false
    threshold: 70
  dependency_scanning:
    enabled: true
    blocking: true  # Critical vulnerabilities block
    create_tasks: true

Script Configuration​

Script-Specific Configuration:

  • Script arguments
  • Tool configuration
  • Output formats
  • Integration settings

Examples​

Example 1: RW Integration​

Scenario: IDE issue detection in RW Step 9

Integration:

  1. RW Step 9 runs IDE issue detection script
  2. Script detects errors, warnings, info
  3. Errors block workflow
  4. Warnings create Kanban tasks
  5. Workflow proceeds if no errors

Example 2: UKW Integration​

Scenario: Automated task creation from quality findings

Integration:

  1. UKW runs quality check automation
  2. Automation identifies quality issues
  3. High-priority issues create Kanban tasks
  4. Tasks use prioritization framework
  5. Kanban board updated

Example 3: CI/CD Integration​

Scenario: Quality gates in CI/CD pipeline

Integration:

  1. CI/CD runs quality check automation
  2. Automation checks quality metrics
  3. Quality gates evaluated
  4. Merge blocked if gates not met
  5. Quality report generated

Best Practices​

Integration Design​

Guidelines:

  • Design integration points carefully
  • Make automation non-blocking when possible
  • Provide clear feedback
  • Handle failures gracefully

Workflow Integration​

Guidelines:

  • Integrate naturally with workflow steps
  • Don't disrupt existing workflow patterns
  • Provide configuration options
  • Document integration points

References​

  • Maintenance Automation Requirements: docs/architecture/standards-and-adrs/maintenance-automation-requirements.md
  • Maintenance Automation Scripts: docs/architecture/standards-and-adrs/maintenance-automation-scripts-and-tools.md
  • Release Workflow: packages/frameworks/workflow mgt/workflows/release-workflow.yaml
  • Update Kanban Workflow: packages/frameworks/workflow mgt/workflows/update-kanban-workflow.yaml
  • Maintenance Workflow Processes: docs/architecture/standards-and-adrs/maintenance-workflow-processes.md
  • Epic 7: docs/project-management/kanban/epics/Epic-7/Epic-7.md
  • Story 4: docs/project-management/kanban/epics/Epic-7/Story-004-maintenance-automation-and-tooling.md

Last updated: 2026-01-05 (v0.7.4.3+0 – Maintenance automation integrated with existing workflows)