Skip to content

GitHub Actions CI/CD

This directory contains GitHub Actions workflows for the Smart Smoker V2 project.

Workflows

ci-tests.yml - Continuous Integration Testing

Triggers: Pull Requests to master branch
Purpose: Runs comprehensive testing suite on all PRs

What it tests: - ✅ Jest unit tests for all 4 applications (backend, device-service, frontend, smoker) - ✅ Package tests (TemperatureChart and future packages) - ✅ TypeScript compilation verification - ✅ Build verification for frontend applications - ✅ Code quality and linting

Jobs: - test: Parallel testing of all applications using matrix strategy - test-packages: Tests shared packages - lint-check: TypeScript compilation verification - build-check: Build verification for React/Electron apps - coverage-report: Aggregates test results and generates summary - all-tests-passed: Final status check (required for merge)

Other Workflows

  • install.yml: Installation and setup workflow
  • build.yml: Application build validation (reusable)
  • publish.yml: Docker Hub publishing (reusable)
  • cloud-deploy.yml: Cloud environment deployment (reusable)
  • smoker-deploy.yml: Smoker environment deployment (reusable)
  • docs.yml: Documentation deployment
  • nightly.yml: Nightly Dev Build & Deploy (publishes :nightly for testing)
  • deploy-version.yml: Manually deploy a specific version/tag to cloud and/or smoker
  • release.yml: Build, publish, and deploy. Supports manual version input and Release tag trigger

Branch Protection

To enforce CI requirements: 1. See .github/BRANCH_PROTECTION_SETUP.md for setup instructions 2. Configure required status checks in GitHub repository settings 3. Require all CI jobs to pass before allowing PR merges

Development Workflow

  1. Create Feature Branch: feature/SS2-XX-description
  2. Make Changes: Develop and commit your changes
  3. Create PR: Open Pull Request to master
  4. CI Runs Automatically: All tests run on your PR
  5. Review Process: Address any failing tests + get code review
  6. Merge: Once CI passes and approved, PR can be merged

CI Status Checks

The following status checks must pass: - Run Jest Tests (backend) - Run Jest Tests (device-service) - Run Jest Tests (frontend) - Run Jest Tests (smoker) - Test Packages - Lint Check - Build Check (frontend) - Build Check (smoker) - All Tests Status

Debugging Failed CI

  1. Check Actions Tab: View detailed logs for failed jobs
  2. Local Testing: Run the same commands locally: 
    cd apps/[app-name]
npm ci --legacy-peer-deps
npm test
  3. TypeScript Issues: Check compilation: 
    cd apps/[app-name]
npx tsc --noEmit
  4. Build Issues: Test builds locally: 
    cd apps/frontend  # or apps/smoker
npm run build

Performance

  • Parallel Execution: Apps tested simultaneously for speed
  • Caching: Node modules cached between runs
  • Timeouts: Jobs timeout after 15 minutes to prevent hanging
  • Artifacts: Test coverage and results preserved for 7 days

Adding New Applications

When adding new apps to the monorepo:

  1. Update Matrix Strategy in ci-tests.yml: 

    strategy:
  matrix:
    app: [backend, device-service, frontend, smoker, new-app]
    include:
      - app: new-app
        path: apps/new-app
        test-command: npm test

  2. Update Branch Protection to include new status checks

  3. Ensure Testing Setup follows the patterns in docs/Packages/testing-template.md

Documentation Dependencies

MkDocs dependencies are managed through mise tasks: - MkDocs: 1.6.1 - Material Theme: 9.6.15 - Installation: mise run docs-install (defined in mise.toml)