CI/CD Workflow

[gbowne1]

I thought some about a GitHub action or workflow for CI/CD for this project.

Thoughts @andrewlod?

name: CI/CD Pipeline

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build-and-test:
    runs-on: ubuntu-latest  # Replace with desired runner OS
    steps:
      - uses: actions/checkout@v3  # Checkout code from repository

      - name: Install dependencies (adapt for your package manager)
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential cmake
          # Install gtest (adapt for your package manager)

      - name: Configure CMake
        working-directory: ${{ github.workspace }}  # Root of the project
        run: cmake -B build

      - name: Build
        working-directory: ${{ github.workspace }}/build
        run: make

      - name: Run tests (if testing enabled)
        working-directory: ${{ github.workspace }}/build
        run: |
          if [[ "${{ env.BUILD_LIBRARY }}" == "ON" ]]; then
            ctest -V
          else
            echo "Testing skipped for non-library builds."
          fi
        env:
          BUILD_LIBRARY: ${{ job.needs.configure.outputs.BUILD_LIBRARY }}  # Inherit from configure step

      - name: Upload test results (optional)
        uses: actions/upload-artifact@v3  # Upload test results for later analysis
        if: always()  # Upload even on failures for troubleshooting
        with:
          name: test-results
          path: ${{ github.workspace }}/build/Testing/*

[gbowne1]

https://resources.github.com/learn/pathways/automation/essentials/building-a-workflow-with-github-actions/

[andrewlod]

@gbowne1

It looks good, however I'm not sure if the application supports ctest yet, at least is hasn't worked for me. I'll look into that at some point.

Just a side note: GitHub Actions is a CI (Continuous Integration Tool). For CD (Continuous Deployment) there are tools such as ArgoCD, AWS CodePipeline (which I am the most familiar with), Azure DevOps, Google Cloud Build, etc. The cloud tools I mentioned are both CI/CD, but are paid.

Not sure if CD is of our interest, since as of my knowledge, GradeBook will be a distributed app, meaning it won't run on cloud as a centralized app.

[gbowne1]

@andrewlod

ctest isn't easy to get started. I havent had much luck with it yet other than small things before. Yeah, we aren't deploying this.

the example I put together is just an example of what the action might look like.

An alternative might be to make some small actions that build, test, etc.