Skip to content

🚀 AudioLab CI/CD Workflows

Overview

Complete automated build, test, security, and release pipeline for AudioLab. All workflows are optimized for performance with intelligent caching and parallel execution.

📋 Workflow Catalog

1. CI - Complete Build & Test (ci-improved.yml) ⭐ PRIMARY

Triggers: Push to main/develop, Pull Requests to main, Manual

Multi-Platform Build Matrix: - ✅ Windows MSVC 2022 - ✅ Ubuntu GCC 11 - ✅ Ubuntu Clang 14 - ✅ macOS Apple Clang

What it does: - Format check (fail-fast) - Build all CORE modules - Run complete test suite - Upload build artifacts - Generate test reports

Duration: ~15-20 min (with cache)

2. Code Quality (code-quality.yml) 🔍

Triggers: Push, PR, Manual

Quality Checks: - ✅ clang-format compliance - ✅ clang-tidy static analysis - ✅ cppcheck additional checks - ✅ Complexity analysis (CCN <15)

Quality Gates: - Code must be formatted - No critical warnings - Complexity within limits

3. Test Suite (test-suite.yml) 🧪

Triggers: Push, PR, Manual

Testing Matrix: - ✅ 3 platforms × 2 build types (Debug/Release) - ✅ Complete code coverage (lcov) - ✅ Codecov integration - ✅ 70% coverage threshold

Coverage Requirement: ≥70% line coverage

4. Security Scan (security-scan.yml) 🔒

Triggers: Push, PR, Weekly (Mon 9AM UTC), Manual

Security Checks: - ✅ CodeQL SAST analysis - ✅ Dependency vulnerabilities - ✅ Secrets detection (TruffleHog) - ✅ License compliance

Schedule: Weekly automated scans

5. Performance Benchmarks (benchmark.yml) 📊

Triggers: Push, PR, Weekly (Sun 12AM UTC), Manual

Benchmarking: - ✅ Google Benchmark suite - ✅ PR vs main comparison - ✅ Regression detection - ✅ Performance reports

6. Release - Multi-Platform (release-improved.yml) 🚀

Triggers: Git tags (v*.*.*), Manual

Release Artifacts: - ✅ Windows x64 (ZIP) - ✅ macOS Universal (tar.gz) - ✅ Linux x64 (tar.gz) - ✅ Auto-generated changelog - ✅ Draft release creation

Usage: 

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

7. Manual Workflows (manual-dispatch.yml) 🛠️

Triggers: Manual only

Available Commands: - full-build - Complete build & test - quick-test - Tests only (no rebuild) - clean-rebuild - Clean rebuild - benchmark - Benchmarks only - security-scan - Security scan - format-fix - Auto-fix formatting

8. Cache Dependencies (cache-deps.yml) ⚡

Triggers: Weekly (Sun 12AM UTC), Manual

Caching: - ✅ vcpkg packages - ✅ Build dependencies - ✅ ~10min time savings

🎯 Status Badges

Add to your README.md:

![CI](https://github.com/yourusername/audio-lab/actions/workflows/ci-improved.yml/badge.svg)
![Quality](https://github.com/yourusername/audio-lab/actions/workflows/code-quality.yml/badge.svg)
![Tests](https://github.com/yourusername/audio-lab/actions/workflows/test-suite.yml/badge.svg)
![Security](https://github.com/yourusername/audio-lab/actions/workflows/security-scan.yml/badge.svg)
[![codecov](https://codecov.io/gh/yourusername/audio-lab/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/audio-lab)

🔧 Configuration

Dependabot (dependabot.yml)

  • GitHub Actions: Weekly (Mon)
  • Python deps: Weekly (Tue)
  • Docker images: Weekly (Wed)

Code Owners (CODEOWNERS)

  • Auto-assign reviewers by file path
  • Core team for CORE modules
  • Security team for security files

Local Testing

Simulate CI Locally

Before pushing, test your changes locally:

1. Format Check

# Windows
cd "2 - FOUNDATION"
.\03_INFRA\03_10_quality_standards\scripts\format_all.ps1 -Check

# Linux
cd "2 - FOUNDATION"
pwsh 03_INFRA/03_10_quality_standards/scripts/format_all.ps1 -Check

2. Build & Test

# Math Primitives
cd "2 - FOUNDATION/04_CORE/04_02_math_primitives"
cmake -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON
cmake --build build --config Release
ctest --test-dir build -C Release --output-on-failure

# Core Interfaces
cd "2 - FOUNDATION/04_CORE/04_01_core_interfaces/04_factory_interfaces"
cmake -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON
cmake --build build --config Release
ctest --test-dir build -C Release --output-on-failure

3. Static Analysis

cd "2 - FOUNDATION/04_CORE/04_02_math_primitives"
cmake -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
clang-tidy -p build **/*.cpp **/*.hpp

CI Configuration

Environment Variables

  • GITHUB_TOKEN - Automatically provided by GitHub Actions
  • CODECOV_TOKEN - (Optional) For Codecov.io integration

Caching Strategy

  • vcpkg packages: Cached by vcpkg.json hash
  • Build artifacts: Not cached (rebuilt each time)
  • Test results: Uploaded as artifacts for 30 days

Supported Platforms

Platform OS Compiler Architecture
Windows windows-latest MSVC 2022 x64
Linux ubuntu-latest GCC 11/Clang 14 x64

Debugging CI Failures

View Logs

  1. Go to the Actions tab in GitHub
  2. Click on the failed workflow run
  3. Select the failed job
  4. Expand the failed step to view logs

Download Test Artifacts

Failed test results are uploaded as artifacts: 1. Go to the workflow run 2. Scroll to Artifacts section 3. Download test-results-windows or test-results-linux

Common Issues

Format Check Fails

Problem: Code style doesn't match clang-format rules

Solution: 

# Auto-format code
cd "2 - FOUNDATION"
.\03_INFRA\03_10_quality_standards\scripts\format_all.ps1

Build Fails (Windows)

Problem: MSVC compiler errors

Solution: - Check that all headers are included - Verify Windows-specific code paths - Review compiler output in Actions logs

Tests Fail

Problem: Unit tests failing in CI but passing locally

Solution: - Check for platform-specific issues - Verify test data paths are relative - Review uploaded test artifacts

Cache Miss

Problem: vcpkg cache not being used

Solution: - Manually trigger cache-deps.yml workflow - Verify vcpkg.json hasn't changed - Check cache key in workflow logs

Workflow Maintenance

Updating Dependencies

When adding new vcpkg dependencies: 1. Update vcpkg.json 2. Manually trigger "Cache Dependencies" workflow 3. Wait for cache to update before next CI run

Modifying Workflows

To update workflows: 1. Edit .github/workflows/*.yml 2. Test locally using act (optional) 3. Push to a feature branch 4. Create PR to review changes

Performance Optimization

Current CI times (approximate): - Format check: ~2 minutes - Windows build: ~10 minutes (5 minutes with cache) - Linux build: ~8 minutes (3 minutes with cache) - Static analysis: ~5 minutes - Total: ~25 minutes (15 minutes with cache)

Security

Secrets Management

No secrets are required for basic CI/CD. Optional secrets: - CODECOV_TOKEN - For coverage upload - RELEASE_TOKEN - For automated releases (uses default GITHUB_TOKEN)

Permissions

Workflows use minimal permissions: - contents: read - Default for checkout - contents: write - Only for releases - No access to secrets or sensitive data

📚 Additional Resources

🎯 Quality Standards

All PRs must pass: - ✅ Format check (clang-format) - ✅ Build on all platforms - ✅ All tests pass - ✅ Coverage ≥70% - ✅ No security issues - ✅ Complexity CCN <15

Maintained by: AudioLab DevOps Team Last Updated: 2025-10-08