Add documentation #1218
Workflow file for this run
This file contains 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: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| # save workspaces to speed up testing | |
| env: | |
| FLOSS_SAVE_WORKSPACE: "True" | |
| jobs: | |
| code_style: | |
| runs-on: ubuntu-20.04 | |
| # Pin action version by commit hash to maximize trust, ref: https://securitylab.github.com/research/github-actions-building-blocks/ | |
| steps: | |
| - name: Checkout FLOSS | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| - name: Set up Python 3.8 | |
| uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4.5.0 | |
| with: | |
| python-version: '3.8' | |
| - name: Install dependencies | |
| run: pip install -e .[dev] | |
| - name: Lint with isort | |
| run: pre-commit run isort | |
| - name: Lint with black | |
| run: pre-commit run black | |
| - name: Check types with mypy | |
| run: pre-commit run mypy | |
| tests: | |
| name: Tests in ${{ matrix.python-version }} on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-20.04, windows-2019, macos-11] | |
| # across all operating systems | |
| # version numbers are strings, not floats | |
| python-version: ['3.8', '3.11'] | |
| include: | |
| # on Ubuntu run these as well | |
| - os: ubuntu-20.04 | |
| python-version: '3.9' | |
| - os: ubuntu-20.04 | |
| python-version: '3.10' | |
| steps: | |
| - name: Checkout FLOSS with submodule | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| with: | |
| submodules: true | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4.5.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install pyyaml | |
| if: matrix.os == 'ubuntu-20.04' | |
| run: sudo apt-get install -y libyaml-dev | |
| - name: Install FLOSS | |
| run: pip install -e .[dev] | |
| - name: Run tests | |
| run: pytest tests/ |