#6 Count pure markup files as documentation #400
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
| # Continuous integration build for pygount. | |
| name: Build | |
| on: [push, pull_request] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| env: | |
| MAIN_PYTHON_VERSION: "3.12" # same as Ubuntu 24 LTS | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: Install dependencies | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: | | |
| poetry install --no-interaction | |
| - name: Build pygount package | |
| run: | | |
| poetry build | |
| - name: Run the test suite | |
| run: | | |
| poetry run pytest --cov=pygount --cov-branch | |
| - name: Build documentation | |
| if: ${{ matrix.python-version == env.MAIN_PYTHON_VERSION }} | |
| run: | | |
| poetry run sh scripts/build_documentation.sh | |
| - name: Update coveralls statistics | |
| if: ${{ matrix.python-version == env.MAIN_PYTHON_VERSION }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| poetry run coveralls --service=github | |
| check-style: | |
| runs-on: ubuntu-latest | |
| # Disable pre-commit check on main and production to prevent | |
| # pull request merges to fail with don't commit to branch". | |
| if: github.ref != 'refs/heads/main' | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install pre-commit | |
| run: | | |
| sudo apt-get install python3 python3-pip | |
| pip install pre-commit | |
| - name: Load cached pre-commit | |
| id: cached-pre-commit | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Install pre-commit hooks | |
| if: steps.cached-pre-commit.outputs.cache-hit != 'true' | |
| run: pre-commit install --install-hooks | |
| - name: Check coding style | |
| run: pre-commit run --all-files |