Add VS Code integration #1097
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: Test | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| defaults: | |
| run: | |
| shell: bash -e {0} # -e to fail on error | |
| jobs: | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python: ["3.10", "3.12"] | |
| os: [ubuntu-latest] | |
| # one that matches "project-name".lower().replace('-', '_'), one that doesn’t: | |
| package-name: [project_name, package_alt] | |
| env: | |
| PROJECT_ROOT: project-name | |
| steps: | |
| # Setup | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| cache: "pip" | |
| cache-dependency-path: "{{cookiecutter.project_name}}/pyproject.toml" | |
| - name: Install Ubuntu system dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get install pandoc | |
| - name: Install build & check dependencies | |
| run: python -m pip install --upgrade pip wheel cookiecutter pre-commit | |
| # Build | |
| - name: Build from template | |
| shell: python | |
| run: | | |
| from cookiecutter.main import cookiecutter | |
| overrides = dict(package_name='${{ matrix.package-name }}') | |
| cookiecutter('.', no_input=True, extra_context=overrides) | |
| # Check | |
| - name: Set up pre-commit cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-3|${{ matrix.python }}|${{ hashFiles(format('{0}/.pre-commit-config.yaml', env.PROJECT_ROOT)) }} | |
| - name: Run pre-commit | |
| run: | | |
| cd "$PROJECT_ROOT" | |
| git add . | |
| pre-commit run --verbose --color=always --show-diff-on-failure --all-files | |
| - name: Install the package | |
| run: | | |
| cd $PROJECT_ROOT | |
| pip install ".[doc]" | |
| python -c "import ${{ matrix.package-name }}" | |
| # Docs | |
| - name: Build the documentation | |
| env: | |
| SPHINXOPTS: -W --keep-going | |
| run: | | |
| cd "$PROJECT_ROOT/docs" | |
| make html | |
| test-scripts: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| cache: "pip" | |
| cache-dependency-path: "**/pyproject.toml" | |
| - name: set python default branch | |
| run: git config --global init.defaultBranch main | |
| - name: Install build dependencies | |
| run: python -m pip install --upgrade pip wheel | |
| - name: Install package | |
| run: pip install ./scripts[test] | |
| - name: Run tests | |
| run: pytest -v --color=yes ./scripts |