Test with linters and formatters #200
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
| # Copyright 2025 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # https://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: 'CI: lint & format checks' | |
| run-name: Test with linters and formatters | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - main | |
| pull_request: | |
| types: [opened, synchronize] | |
| merge_group: | |
| types: | |
| - checks_requested | |
| workflow_dispatch: | |
| inputs: | |
| debug: | |
| description: 'Run with debugging options' | |
| type: boolean | |
| default: true | |
| permissions: read-all | |
| concurrency: | |
| # Cancel any previously-started but still active runs on the same branch. | |
| cancel-in-progress: true | |
| group: ${{github.workflow}}-${{github.event.pull_request.number||github.ref}} | |
| jobs: | |
| find-changes: | |
| name: Find changed files | |
| uses: ./.github/workflows/reusable_find_changes.yaml | |
| secrets: inherit | |
| check-format: | |
| # For efficiency, skip this workflow if there were no Python file changes. | |
| if: needs.find-changes.outputs.python || github.event_name == 'workflow_dispatch' | |
| name: Python format check | |
| needs: find-changes | |
| runs-on: ubuntu-24.04 | |
| timeout-minutes: 30 | |
| steps: | |
| - name: Check out a copy of the git repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
| with: | |
| # Need the full git history for format-incremental. | |
| fetch-depth: 0 | |
| - name: Set up Python with caching of pip dependencies | |
| uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 | |
| with: | |
| python-version: '3.13' | |
| cache: pip | |
| cache-dependency-path: | | |
| requirements.txt | |
| dev-requirements.txt | |
| - name: Install qsim development dependencies | |
| run: | | |
| pip install -r requirements.txt | |
| pip install -r dev-requirements.txt | |
| - name: Check Python file format | |
| env: | |
| # SHELLOPTS is used by Bash. Add xtrace when doing manual debug runs. | |
| SHELLOPTS: ${{inputs.debug && 'xtrace' || '' }} | |
| run: check/format-incremental |