A customisable GitHub action to check the style of Python code with interrogate.
You can use inputs to alter how interrogate will check your code docstrings.
This tells interrogate where to look for files to check.
Fail when coverage % is less than a given amount.
Default: 80
Generate a shields.io status badge (an SVG image) in at a given file or directory.
Default: .
Ignore module-level docstrings when running interrogate.
Default: False
Include this in your .github/workflows/main.yaml:
uses: JackMcKew/python-interrogate-check@main
with:
path: 'package_name'Here is an entire workflow for updating a badge as well. Note you will need to set up an access token for the repository.
name: Interrogate documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Python Interrogate Check
uses: JackMcKew/python-interrogate-check@main
with:
path: 'sample_package'
badge-location: 'badges/interrogate_badge.svg'
- name: Commit files
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add badges/interrogate_badge.svg
git diff --exit-code || git commit -m "Update interrogate_badge.svg" -a
- name: Push changes
if: success()
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.ACCESS_TOKEN }}
Python Interrogate Check is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Python Interrogate Check is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.