Merge pull request #10 from Infleqtion/github-workflows

Add github continuous integration workflow
Infleqtion · Jan 12, 2024 · 83f50d4 · 83f50d4
2 parents 11c4988 + a97e5db
commit 83f50d4
Show file tree

Hide file tree

Showing 10 changed files with 133 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,129 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+ types: [ opened, synchronize, reopened, ready_for_review ] # these are the defaults, plus ready_for_review
+ branches: [ main ]
+ workflow_dispatch:
+ workflow_call:
+
+jobs:
+ format:
+ name: Format check
+ if: github.event.pull_request.draft == false
+ runs-on: ubuntu-latest
+ timeout-minutes: 3
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/cache@v3
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+ - name: Install dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install '.[dev]'
+ - name: Format
+ run: |
+ checks/format_.py
+
+ lint:
+ name: Lint check
+ if: github.event.pull_request.draft == false
+ runs-on: ubuntu-latest
+ timeout-minutes: 3
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/cache@v3
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+ - name: Install dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install '.[dev]'
+ - name: Pylint
+ run: |
+ checks/pylint_.py --all
+
+ flake8:
+ name: Flake8 check
+ if: github.event.pull_request.draft == false
+ runs-on: ubuntu-latest
+ timeout-minutes: 3
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/cache@v3
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+ - name: Install dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install '.[dev]'
+ - name: Flake8
+ run: |
+ checks/flake8_.py
+
+ mypy:
+ name: Type check
+ if: github.event.pull_request.draft == false
+ runs-on: ubuntu-latest
+ timeout-minutes: 3
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/cache@v3
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+ - name: Install dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install '.[dev]'
+ - name: Type check
+ run: |
+ checks/mypy_.py
+
+ coverage:
+ name: Pytest and Coverage check
+ if: github.event.pull_request.draft == false
+ runs-on: ubuntu-latest
+ timeout-minutes: 3
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python 3.11
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ - uses: actions/cache@v3
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+ - name: Install dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install '.[dev]'
+ - name: Coverage check
+ run: |
+ checks/coverage_.py
diff --git a/check/all_.py → checks/all_.py b/check/all_.py → checks/all_.py
diff --git a/check/configs.py → checks/configs.py b/check/configs.py → checks/configs.py
diff --git a/check/coverage_.py → checks/coverage_.py b/check/coverage_.py → checks/coverage_.py
diff --git a/check/flake8_.py → checks/flake8_.py b/check/flake8_.py → checks/flake8_.py
diff --git a/check/format_.py → checks/format_.py b/check/format_.py → checks/format_.py
diff --git a/check/mypy_.py → checks/mypy_.py b/check/mypy_.py → checks/mypy_.py
diff --git a/check/pylint_.py → checks/pylint_.py b/check/pylint_.py → checks/pylint_.py
diff --git a/check/pytest_.py → checks/pytest_.py b/check/pytest_.py → checks/pytest_.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,6 +36,10 @@ networkx = ">=2.6.2"
 numpy = ">=1.22.0"
 sympy = ">=1.12"
 
+# TODO: remove once https://github.com/python/typeshed/issues/11254 is resolved
+# more context: https://github.com/Infleqtion/qLDPC/pull/10
+types-protobuf = "<=4.24.0.4"
+
 checks-superstaq = { version = ">=0.5.0", optional = true }
 
 [tool.poetry.extras]