This GitHub Action runs Vulture, a tool for detecting unused Python code, on your repository. It helps you identify and eliminate dead code, improving your project's maintainability and reducing its complexity.
- Easy integration with GitHub workflows.
- Flexible configuration using Vulture's CLI arguments.
- Supports all Vulture options and features.
- Customizable for different project structures and requirements.
To use this action in your workflow, include the gtkacz/vulture-action action on one of your GitHub workflow yml files. The file may look like the following:
name: Vulture Dead Code Check
on: [push, pull_request]
jobs:
vulture:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run Vulture
uses: gtkacz/[email protected]
with:
args: '. --min-confidence 70 --exclude "tests,docs" --verbose'This action accepts three inputs:
src: Source to run vulture. Default:..args: Arguments passed to Vulture. Usevulture --helpto see available options or refer to the Vulture documentation.version: The version of Vulture to use, e.g.==2.11.0. Default is null.
Scan the entire repository with default settings:
- name: Run Vulture
uses: gtkacz/[email protected]Scan with a minimum confidence of 80%, excluding specific directories, and using verbose output:
- name: Run Vulture
uses: gtkacz/[email protected]
with:
args: '--min-confidence 80 --exclude "tests,docs,build" --verbose'Scan only the src directory:
- name: Run Vulture
uses: gtkacz/vulture-action@v1
with:
src: 'package'Contributions to improve this GitHub Action are welcome! Please feel free to submit issues or pull requests.
This project is licensed under the MIT License - see the LICENSE file for details.
- This action uses Vulture, created by Jendrik Seipp.
- Thanks to the GitHub Actions team for providing the platform and documentation.
If you encounter any problems or have any questions, please open an issue in this repository.