Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gtkacz/vulture-action
A GitHub action for Vulture.
https://github.com/gtkacz/vulture-action
code-analysis code-analysis-true code-quality dead-code github-actions pip python
Last synced: 8 days ago
JSON representation
A GitHub action for Vulture.
- Host: GitHub
- URL: https://github.com/gtkacz/vulture-action
- Owner: gtkacz
- License: mit
- Created: 2024-09-11T20:30:01.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T12:54:42.000Z (4 months ago)
- Last Synced: 2024-11-02T07:14:08.815Z (about 2 months ago)
- Topics: code-analysis, code-analysis-true, code-quality, dead-code, github-actions, pip, python
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vulture Dead Code Scanner GitHub Action
This GitHub Action runs [Vulture](https://github.com/jendrikseipp/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.
## 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, include the `gtkacz/vulture-action` action on one of your GitHub workflow yml files. The file may look like the following:
```yaml
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'
```
## Inputs
This action accepts three inputs:
- `src`: Source to run vulture. Default: `.`.
- `args`: Arguments passed to Vulture. Use `vulture --help` to see available options or refer to the [Vulture documentation](https://github.com/jendrikseipp/vulture#usage).
- `version`: The version of Vulture to use, e.g. `==2.11.0`. Default is null.
## Examples
### Basic Usage
Scan the entire repository with default settings:
```yaml
- name: Run Vulture
uses: gtkacz/[email protected]
```
### Custom Configuration
Scan with a minimum confidence of 80%, excluding specific directories, and using verbose output:
```yaml
- name: Run Vulture
uses: gtkacz/[email protected]
with:
args: '--min-confidence 80 --exclude "tests,docs,build" --verbose'
```
### Scanning Specific Files or Directories
Scan only the `src` directory:
```yaml
- name: Run Vulture
uses: gtkacz/vulture-action@v1
with:
src: 'package'
```
## 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](LICENSE) file for details.
## Acknowledgements
- This action uses [Vulture](https://github.com/jendrikseipp/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.