CI reports and artifacts

Glade writes machine-readable check results and saved test reports for CI.

Advisory pilot

Use this workflow while evaluating supported local paths. The example pins the v0.2.14 stable release; change the pin deliberately after reviewing a newer release. The product does not install plugins here; pin a plugin lock file too if your workflow adds them.

name: glade-pilot
on: [pull_request]
permissions:
  contents: read
jobs:
  glade:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - run: curl -fsSL https://glade.sh/install.sh | env GLADE_VERSION=v0.2.14 sh
      - run: echo "$HOME/.local/bin" >> "$GITHUB_PATH"
      - run: glade version
      - run: glade doctor --project .
      - run: mkdir -p reports
      - name: Assess local source
        id: check
        continue-on-error: true
        run: glade check --project . --format sarif --output reports/glade-check.sarif --no-progress
      - name: Run affected tests
        id: tests
        continue-on-error: true
        run: glade test changed --project . --since origin/main --json --no-progress > reports/glade-test-changed.json
      - name: Record assessment outcomes
        if: always()
        run: |
          echo "check=${{ steps.check.outcome }}" >> "$GITHUB_STEP_SUMMARY"
          echo "tests=${{ steps.tests.outcome }}" >> "$GITHUB_STEP_SUMMARY"
      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: glade-results
          path: reports/

Install and doctor failures remain setup failures. Assessment/test failures are visible in step outcomes and retained artifacts without blocking the pilot job. Do not mark this job as required until the team chooses the enforcing contract below.

Enforcing gate

After comparing representative results with Salesforce, use the same pinned setup and replace the two assessment/test steps with these. There is no continue-on-error, so either failure fails the job. Keep the always-run outcome and artifact steps from the pilot.

      - name: Check local source
        id: check
        run: glade check --project . --format sarif --output reports/glade-check.sarif --no-progress
      - name: Run local tests
        id: tests
        run: glade test --project . --junit reports/glade-junit.xml --no-progress

Choose the test scope your team has validated; a local gate does not replace the final Salesforce validation. Before adopting either variant, intentionally fail a public test and confirm that the advisory job retains evidence while the enforcing job fails.

Semantic checks

Use fetch-depth: 0 when a workflow runs glade test changed --project . --since origin/main. The affected-test selector needs the git base ref on disk.

Use SARIF for code-scanning uploads:

glade check --project . --format sarif --output glade-check.sarif

Use GitHub annotations for inline workflow logs:

glade check --project . --format github

JSON remains available:

glade check --project . --format json --output glade-check.json --no-progress

--json is still accepted as the short form for --format json. JSON output uses the versioned envelope in Automation and JSON.

Saved test runs

glade dev test writes a saved run directory under .glade/runs:

glade dev test --project . --out .glade/runs

Each run contains run.json, results.json, summary.md, junit.xml, and events.ndjson.

Read the latest run as JSON:

glade report show latest --runs-dir .glade/runs --json

Emit GitHub annotations for the latest failing tests:

glade report github latest --runs-dir .glade/runs

Export a browsable HTML artifact:

glade report export latest --runs-dir .glade/runs --format html --output glade-report.html

The default export remains a zip:

glade report export latest --runs-dir .glade/runs --output glade-report.zip

Refactor proof reports

Use a proof report when CI needs a branch-change artifact:

mkdir -p reports
glade report refactor-proof --project . --since origin/main --format html --out reports/glade-refactor-proof.html
glade report refactor-proof --project . --since origin/main --fail-on-api-break --format json

The report records the git diff, parse and semantic status, graph impact, affected-test selection, optional trace summary, and public or global API warnings.

Upload the files after a gate, even when the test or check step fails:

      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: glade-results
          path: |
            glade-check.sarif
            reports/glade-junit.xml
            .glade/runs

glade check and glade test return non-zero for diagnostics or failed test outcomes that should block a gate. Use if: always() only for upload steps that must run after a failure. Exit codes are listed in Exit codes.