Skip to content

CI(deps): Update astral-sh/setup-uv action to v7.3.1 (releasebranch_8… #13055

CI(deps): Update astral-sh/setup-uv action to v7.3.1 (releasebranch_8…

CI(deps): Update astral-sh/setup-uv action to v7.3.1 (releasebranch_8… #13055

---
name: Python Code Quality
on:
push:
branches:
- main
- releasebranch_*
pull_request:
permissions: {}
jobs:
python-checks:
name: Python Code Quality Checks
concurrency:
group: ${{ github.workflow }}-${{ github.job }}-${{
github.event_name == 'pull_request' &&
github.head_ref || github.sha }}
cancel-in-progress: true
strategy:
matrix:
include:
- os: ubuntu-22.04
env:
# renovate: datasource=python-version depName=python
PYTHON_VERSION: "3.10"
MIN_PYTHON_VERSION: "3.8"
# renovate: datasource=pypi depName=black
BLACK_VERSION: "24.10.0"
# renovate: datasource=pypi depName=flake8
FLAKE8_VERSION: "5.0.4"
# renovate: datasource=pypi depName=pylint
PYLINT_VERSION: "2.12.2"
# renovate: datasource=pypi depName=bandit
BANDIT_VERSION: "1.9.3"
runs-on: ${{ matrix.os }}
permissions:
security-events: write
steps:
- name: Versions
run: |
echo "OS: ${MATRIX_OS}"
echo "Python: ${PYTHON_VERSION}"
echo "Minimal Python version: ${MIN_PYTHON_VERSION}"
echo "Black: ${BLACK_VERSION}"
echo "Flake8: ${FLAKE8_VERSION}"
echo "Pylint: ${PYLINT_VERSION}"
echo "Bandit: ${BANDIT_VERSION}"
env:
MATRIX_OS: ${{ matrix.os }}
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: ${{ env.PYTHON_VERSION }}
cache: pip # zizmor: ignore[cache-poisoning] Not creating release artifacts, less of a concern here
- name: Upgrade pip
run: python -m pip install --upgrade pip
- name: Install Black only
run: pip install "black[jupyter]==${BLACK_VERSION}"
- name: Run Black
run: black .
- name: Create and uploads code suggestions to apply for Black
# Will fail fast here if there are changes required
id: diff-black
uses: ./.github/actions/create-upload-suggestions
with:
tool-name: black
# To keep repo's file structure in formatted changes artifact
extra-upload-changes: .clang-format
- name: Install non-Python dependencies
run: |
sudo apt-get update -y
sudo apt-get install -y wget git gawk findutils
xargs -a <(awk '! /^ *(#|$)/' ".github/workflows/apt.txt") -r -- \
sudo apt-get install -y --no-install-recommends --no-install-suggests
- name: Install Python dependencies
run: |
pip install -r .github/workflows/python_requirements.txt
pip install -r .github/workflows/optional_requirements.txt
pip install "flake8==${FLAKE8_VERSION}"
pip install "pylint==${PYLINT_VERSION}" pytest-github-actions-annotate-failures
pip install "bandit[sarif]==${BANDIT_VERSION}"
- name: Run Flake8
run: |
flake8 --count --statistics --show-source --jobs="$(nproc)" .
- name: Run Flake8 on additional files
run: |
flake8 --count --statistics --show-source --jobs="$(nproc)" python/grass/{script,jupyter}/testsuite/
- name: Bandit Vulnerability Scan
run: |
bandit -c pyproject.toml -iii -r . -f sarif -o bandit.sarif --exit-zero
- name: Upload Bandit Scan Results
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: bandit.sarif
path: bandit.sarif
- name: Upload SARIF File into Security Tab
uses: github/codeql-action/upload-sarif@9e907b5e64f6b83e7804b09294d44122997950d6 # v4.32.3
with:
sarif_file: bandit.sarif
- name: Create installation directory
run: |
mkdir "${HOME}/install"
- name: Set number of cores for compilation
run: |
echo "MAKEFLAGS=-j$(nproc)" >> "${GITHUB_ENV}"
- uses: rui314/setup-mold@725a8794d15fc7563f59595bd9556495c0564878 # v1
- name: Build
run: |
".github/workflows/build_${MATRIX_OS}.sh" "${HOME}/install"
env:
MATRIX_OS: ${{ matrix.os }}
- name: Add the bin directory to PATH
run: |
echo "${HOME}/install/bin" >> "${GITHUB_PATH}"
- name: Run Pylint on grass package
run: |
PYTHONPATH="$(grass --config python_path):$PYTHONPATH"
LD_LIBRARY_PATH="$HOME/install/grass84/lib:$LD_LIBRARY_PATH"
export PYTHONPATH
export LD_LIBRARY_PATH
cd python
pylint --persistent=no --py-version="${MIN_PYTHON_VERSION}" --jobs="$(nproc)" grass
- name: Run Pylint on wxGUI
run: |
PYTHONPATH="$(grass --config python_path):$PYTHONPATH"
LD_LIBRARY_PATH="$HOME/install/grass84/lib:$LD_LIBRARY_PATH"
export PYTHONPATH
export LD_LIBRARY_PATH
cd gui/wxpython
# shellcheck disable=SC2035
pylint --persistent=no --py-version="${MIN_PYTHON_VERSION}" --jobs="$(nproc)" *
- name: Run Pylint on other files using pytest
run: |
pip install pytest==7.4.4 pytest-pylint==0.19
echo "::warning file=.github/workflows/python-code-quality.yml,line=149,col=42,endColumn=48::\
Temporarily downgraded pytest-pylint and pytest to allow merging other PRs.\
The errors reported with a newer version seem legitimite and should be fixed \
(2023-10-18, see https://github.com/OSGeo/grass/pull/3205)\
(2024-01-28, see https://github.com/OSGeo/grass/issues/3380)"
PYTHONPATH="$(grass --config python_path):$PYTHONPATH"
LD_LIBRARY_PATH="$HOME/install/grass84/lib:$LD_LIBRARY_PATH"
export PYTHONPATH
export LD_LIBRARY_PATH
pytest --pylint -m pylint --pylint-rcfile=.pylintrc --pylint-jobs="$(nproc)" \
--pylint-ignore-patterns="${PylintIgnore}"
env:
PylintIgnore: "python/.*,gui/wxpython/.*,doc/.*,man/.*,utils/.*,locale/.*,raster/.*,\
imagery/.*,scripts/r.in.wms/wms_drv.py,scripts/g.extension/g.extension.py,\
temporal/t.rast.accdetect/t.rast.accdetect.py,temporal/t.rast.accumulate/t.rast.accumulate.py,\
scripts/d.rast.edit/d.rast.edit.py"
- name: Test compiling example modules
run: |
( cd doc/raster/r.example/ && make )
( cd doc/vector/v.example/ && make )
- name: Run Sphinx to check API documentation build
run: |
pip install sphinx
make sphinxdoclib
ARCH="$(grep ^ARCH include/Make/Platform.make | cut -d'=' -f2 | xargs)"
cp -rp "dist.${ARCH}/docs/html/libpython" sphinx-grass
- name: Make Sphinx documentation available
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: sphinx-grass
path: sphinx-grass
retention-days: 3
python-success:
name: Python Code Quality Result
needs:
- python-checks
if: ${{ always() }}
uses: ./.github/workflows/verify-success.yml
with:
needs_context: ${{ toJson(needs) }}