Skip to main content

Build & CI/CD documentation

Build & CI/CD Documentation​

This section provides comprehensive documentation for all build processes, continuous integration workflows, and deployment automation used in the Edge AI Accelerator project.

In this guide​

Overview​

The Edge AI Accelerator uses multiple CI/CD platforms and build automation tools to ensure code quality, security, and reliable deployments:

  • GitHub Actions: Primary CI/CD platform for pull request validation, testing, and deployment
  • Azure DevOps: Enterprise CI/CD pipeline for infrastructure testing and deployment
  • Build Scripts: Automated validation, documentation generation, and compliance checking
  • Security Scanning: Integrated security validation and vulnerability assessment

CI/CD platforms​

GitHub Actions workflows​

Our GitHub Actions workflows provide automated validation and deployment capabilities:

WorkflowPurposeDocumentation
Main CI/CDPrimary workflow orchestrationGitHub Actions Guide
Pull Request ValidationCode quality and compliance validationGitHub Actions Guide
Documentation ValidationInfrastructure documentation consistencyGitHub Actions Guide
Security ScanningCode quality and security validationGitHub Actions Guide
Pages DeploymentDocumentation site deploymentGitHub Actions Guide

Detailed workflow documentation: GitHub Actions Templates

Azure DevOps pipelines​

Our Azure DevOps pipelines handle enterprise infrastructure testing and deployment:

PipelinePurposeDocumentation
Infrastructure TestingComprehensive Terraform and Bicep validationAzure DevOps Guide
Matrix TestingParallel testing of multiple infrastructure componentsAzure DevOps Guide
Deployment OrchestrationMulti-environment deployment workflowsAzure DevOps Guide
Security IntegrationSecurity scanning and compliance validationAzure DevOps Guide

Detailed pipeline documentation: Azure DevOps Templates

Build processes​

Automated validation scripts​

The project includes comprehensive build scripts for validation and automation:

Script CategoryPurposeDocumentation
Documentation ValidationTerraform and Bicep documentation consistencyBuild Scripts Guide
Variable ComplianceInfrastructure variable validation and complianceBuild Scripts Guide
Security ScanningCheckov security validation and vulnerability assessmentSecurity Scanning Guide
Version CheckingAzure IoT Operations version validationBuild Scripts Guide
Folder DetectionMatrix build folder change detectionBuild Scripts Guide

Build automation​

  • Documentation Generation: Automated Terraform and Bicep documentation
  • Wiki Documentation: Comprehensive Azure DevOps wiki publishing with content from all documentation areas
  • Dependency Management: Package and provider version management
  • Quality Assurance: Linting, formatting, and compliance validation

Learn more about build processes

Security and validation​

Security scanning integration​

  • Checkov Integration: Infrastructure as code security scanning
  • Dependency Scanning: Package vulnerability assessment
  • Compliance Validation: Policy and standard compliance checking

Code quality validation​

  • Individual Lint Jobs: Dedicated linting for shell, YAML, Python, PowerShell, Bicep, Terraform, and documentation
  • Format Validation: Markdown, YAML, and code formatting standards
  • Link Validation: Documentation link consistency and accuracy

Learn more about security processes

Templates and reference​

Reusable templates​

Reference documentation​

Troubleshooting​

Common build issues​

  • Workflow Failures: GitHub Actions troubleshooting and debugging
  • Pipeline Errors: Azure DevOps pipeline issue resolution
  • Script Failures: Build script debugging and error resolution
  • Dependency Issues: Package and provider version conflicts

Complete troubleshooting guide

Best practices​

  • CI/CD Patterns: Established workflow and pipeline patterns
  • Security Best Practices: Secure CI/CD configuration and secret management
  • Performance Optimization: Build performance and efficiency improvements

Learn about CI/CD best practices

Getting started​

For developers​

  1. Review Prerequisites: Understand required tools and permissions
  2. Local Development: Set up build tools for local development
  3. Testing Workflows: Validate changes before pull request submission

For DevOps engineers​

  1. Pipeline Configuration: Understanding and modifying CI/CD pipelines
  2. Template Management: Creating and maintaining reusable templates
  3. Security Integration: Implementing security scanning and validation

For contributors​

  1. Build Process: Understanding automated validation and testing
  2. Documentation Standards: Maintaining documentation consistency
  3. Quality Standards: Meeting code quality and security requirements

🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.