ci: do not run full application build/tests for docs-only changes #407
Workflow file for this run
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: ci | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| merge_group: | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pull-requests: read # for dorny/paths-filter in changes job | |
| concurrency: | |
| group: ci-${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | |
| jobs: | |
| changes: | |
| # Detect whether source code changed. On non-PR events (push, merge_group, | |
| # workflow_dispatch) this job is skipped, which causes all downstream jobs to | |
| # run unconditionally via the `needs.changes.result == 'skipped'` guard. | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: read | |
| outputs: | |
| code: ${{ steps.filter.outputs.code }} | |
| steps: | |
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | |
| id: filter | |
| with: | |
| filters: | | |
| code: | |
| - 'src/**' | |
| - 'test/**' | |
| - 'scripts/**' | |
| - 'package.json' | |
| - 'package-lock.json' | |
| - 'tsconfig*.json' | |
| - '.nvmrc' | |
| - '.github/actions/**' | |
| - '.github/workflows/ci.yml' | |
| unit-test: | |
| needs: [changes] | |
| if: always() | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| runs-on: ${{ matrix.os }} | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Harden runner | |
| uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4 | |
| with: | |
| egress-policy: audit | |
| - name: Check if application build/tests are needed | |
| id: should-run | |
| run: | | |
| if [ "${{ github.event_name }}" = "pull_request" ] && [ "${{ needs.changes.outputs.code }}" != "true" ]; then | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| echo "Only documentation or non-code changes detected. Skipping application build and tests." | |
| else | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Checkout | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Node.js | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: ./.github/actions/setup-node | |
| - name: Run tests | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: npm test | |
| - name: Check code coverage | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && matrix.os == 'ubuntu-latest' | |
| id: coverage | |
| run: | | |
| output=$(npm run test:coverage 2>&1) | |
| echo "$output" | |
| pct=$(echo "$output" | grep 'all files' | head -1 | awk -F'|' '{gsub(/[[:space:]]/, "", $2); print $2}') | |
| echo "percentage=$pct" >> "$GITHUB_OUTPUT" | |
| - name: Determine badge color | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && matrix.os == 'ubuntu-latest' | |
| id: color | |
| run: | | |
| pct="${{ steps.coverage.outputs.percentage }}" | |
| int_pct=${pct%.*} | |
| if [ "$int_pct" -ge 90 ]; then | |
| echo "color=brightgreen" >> "$GITHUB_OUTPUT" | |
| elif [ "$int_pct" -ge 80 ]; then | |
| echo "color=green" >> "$GITHUB_OUTPUT" | |
| elif [ "$int_pct" -ge 70 ]; then | |
| echo "color=yellowgreen" >> "$GITHUB_OUTPUT" | |
| elif [ "$int_pct" -ge 60 ]; then | |
| echo "color=yellow" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "color=red" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Update coverage badge | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && matrix.os == 'ubuntu-latest' && github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| continue-on-error: true | |
| uses: schneegans/dynamic-badges-action@0e50b8bad39e7e1afd3e4e9c2b7dd145fad07501 # v1.8.0 | |
| with: | |
| auth: ${{ secrets.GIST_TOKEN }} | |
| gistID: d01e4551b744b77e2927555e43a4b935 | |
| filename: coverage.json | |
| label: coverage | |
| message: ${{ steps.coverage.outputs.percentage }}% | |
| color: ${{ steps.color.outputs.color }} | |
| build: | |
| needs: [changes] | |
| if: always() | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Harden runner | |
| uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4 | |
| with: | |
| egress-policy: audit | |
| - name: Check if application build is needed | |
| id: should-run | |
| run: | | |
| if [ "${{ github.event_name }}" = "pull_request" ] && [ "${{ needs.changes.outputs.code }}" != "true" ]; then | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| echo "Only documentation or non-code changes detected. Skipping application build." | |
| else | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Checkout | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Node.js | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: ./.github/actions/setup-node | |
| - name: Compile | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: npm run compile | |
| - name: Package extension | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: npm run package | |
| integration-test: | |
| needs: [changes, unit-test, build] | |
| if: always() | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| runs-on: ${{ matrix.os }} | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Harden runner | |
| if: runner.os == 'Linux' | |
| uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4 | |
| with: | |
| egress-policy: audit | |
| - name: Check if application tests are needed | |
| id: should-run | |
| run: | | |
| if [ "${{ github.event_name }}" = "pull_request" ] && [ "${{ needs.changes.outputs.code }}" != "true" ]; then | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| echo "Only documentation or non-code changes detected. Skipping integration tests." | |
| else | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Checkout | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Node.js | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| uses: ./.github/actions/setup-node | |
| - name: Compile extension and tests | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: npm run compile && npm run compile-tests | |
| - name: Run extension integration tests (Linux) | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && runner.os == 'Linux' | |
| run: xvfb-run -a npm run test:extension | |
| - name: Run extension integration tests | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && runner.os != 'Linux' | |
| run: npm run test:extension | |
| - name: Setup UI test VS Code | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: npx extest setup-tests --code_version max --extensions_dir .vscode-test/extensions | |
| - name: Patch test VS Code to run as background app | |
| if: steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request' | |
| run: bash scripts/hide-test-vscode.sh | |
| - name: Run UI tests (Linux) | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && runner.os == 'Linux' | |
| run: xvfb-run -a npx extest run-tests './out-uitest/test/ui/*.test.js' --extensions_dir .vscode-test/extensions | |
| - name: Run UI tests | |
| if: (steps.should-run.outputs.run == 'true' || github.event_name != 'pull_request') && runner.os != 'Linux' | |
| run: npx extest run-tests './out-uitest/test/ui/*.test.js' --extensions_dir .vscode-test/extensions |