Vulture Dead Code Scanner GitHub Action

This GitHub Action runs Vulture, a tool for detecting and removing unused Python code, on your repository. It helps you identify and eliminate dead code, improving your project's maintainability and reducing its complexity.

Features

• 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

Usage

To use this action in your workflow, create a .github/workflows/vulture.yml file in your repository with the following content:

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/vulture-action@v1
      with:
        args: '. --min-confidence 70 --exclude "tests,docs" --verbose'

Inputs

This action accepts a single input:

• args: Command line arguments to pass to Vulture (required, default: '.')

You can use any valid Vulture CLI arguments in this input. For a full list of available options, refer to the Vulture documentation.

Examples

Basic Usage

Scan the entire repository with default settings:

- name: Run Vulture
  uses: gtkacz/vulture-action@v1

Custom Configuration

Scan with a minimum confidence of 80%, excluding specific directories, and using verbose output:

- name: Run Vulture
  uses: gtkacz/vulture-action@v1
  with:
    args: '. --min-confidence 80 --exclude "tests,docs,build" --verbose'

Scanning Specific Files or Directories

Scan only the src directory:

- name: Run Vulture
  uses: gtkacz/vulture-action@v1
  with:
    args: 'src'

Using a Configuration File

If you have a vulture_config.py file in your repository:

- name: Run Vulture
  uses: gtkacz/vulture-action@v1
  with:
    args: '. --make-whitelist vulture_config.py'

Customizing the Action

You can customize the action by modifying the action.yml file. The current implementation allows for maximum flexibility, but you might want to add specific inputs or steps based on your project's needs.

Contributing

Contributions to improve this GitHub Action are welcome! Please feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• This action uses Vulture, created by Jendrik Seipp.
• Thanks to the GitHub Actions team for providing the platform and documentation.

Support

If you encounter any problems or have any questions, please open an issue in this repository.

Full Changelog: https://github.com/gtkacz/vulture-action/commits/1.0.0