docs(sql): add Doxygen comments to modules #306
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "Test EQL" | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - ".github/workflows/test-eql.yml" | |
| - "src/**/*.sql" | |
| - "sql/**/*.sql" | |
| - "tests/**/*" | |
| - "tasks/**/*" | |
| pull_request: | |
| # run on all pull requests | |
| paths: | |
| - ".github/workflows/test-eql.yml" | |
| - "src/**/*.sql" | |
| - "sql/**/*.sql" | |
| - "tests/**/*" | |
| - "tasks/**/*" | |
| workflow_dispatch: | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| validate-docs: | |
| name: "Validate SQL Documentation" | |
| runs-on: ubuntu-latest-m | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check documentation coverage | |
| run: | | |
| chmod +x tasks/check-doc-coverage.sh | |
| ./tasks/check-doc-coverage.sh | |
| - name: Validate required Doxygen tags | |
| run: | | |
| chmod +x tasks/validate-required-tags.sh | |
| ./tasks/validate-required-tags.sh | |
| test: | |
| name: "Test EQL SQL components" | |
| runs-on: ubuntu-latest-m | |
| needs: validate-docs | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| postgres-version: [17, 16, 15, 14] | |
| env: | |
| POSTGRES_VERSION: ${{ matrix.postgres-version }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jdx/mise-action@v2 | |
| with: | |
| version: 2025.1.6 # [default: latest] mise version to install | |
| install: true # [default: true] run `mise install` | |
| cache: true # [default: true] cache mise using GitHub's cache | |
| - name: Setup database (Postgres ${{ matrix.postgres-version }}) | |
| run: | | |
| mise run postgres:up postgres-${POSTGRES_VERSION} --extra-args "--detach --wait" | |
| - name: Test EQL for Postgres ${{ matrix.postgres-version }} | |
| run: | | |
| mise run --output prefix test --postgres ${POSTGRES_VERSION} |