Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dciborow/pyaction
https://github.com/dciborow/pyaction
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dciborow/pyaction
- Owner: dciborow
- License: mit
- Created: 2022-04-23T20:30:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-18T11:48:56.000Z (almost 2 years ago)
- Last Synced: 2024-11-21T03:39:34.045Z (3 months ago)
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-action
[](https://github.com/dciborow/pyaction/actions?query=workflow%3ATest)
[](https://github.com/dciborow/pyaction/actions?query=workflow%3Areviewdog)
[](https://github.com/dciborow/pyaction/actions?query=workflow%3Adepup)
[](https://github.com/dciborow/pyaction/actions?query=workflow%3Arelease)
[](https://github.com/dciborow/pyaction/releases)
[](https://github.com/haya14busa/action-bumpr)
This repo contains a action to run various Python tools including:
- [bandit](https://pypi.org/project/bandit)
- [black](https://pypi.org/project/black)
- [flake8](https://pypi.org/project/flake8)
- [pylint](https://pypi.org/project/pylint)
- [pyright](https://pypi.org/project/pyright)
- [pytest](https://pypi.org/project/pytest)
## Input
```yaml
inputs:
black:
description: |
Run Black
Default is false.
default: false
bandit:
description: |
Run Bandit
Default is false.
default: false
pylint:
description: |
Run Pylint
Default is false.
default: false
pyright:
description: |
Run Pyright
Default is false.
default: false
flake8:
description: |
Run Flake8
Default is false.
default: false
testing:
description: |
Run tests with PyTest
Default is false.
default: false
publish:
description: |
Publish to PyPi
Default is false
default: false
publish_url:
description: |
PyPi Target. Use this to point to private or test locations.
Default https://pypi.org
defualt: 'https://pypi.org'
github_token:
description: 'GITHUB_TOKEN'
default: '${{ github.token }}'
workdir:
description: 'Working directory relative to the root directory.'
default: 'src'
### Flags for reviewdog ###
level:
description: 'Report level for reviewdog [info,warning,error]'
default: 'error'
reporter:
description: 'Reporter of reviewdog command [github-pr-check,github-pr-review].'
default: 'github-pr-check'
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
default: 'added'
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
default: 'false'
reviewdog_flags:
description: 'Additional reviewdog flags'
default: ''
toml:
description: |
pyproject.toml location.
Default pyproject.toml
default: 'pyproject.toml'
pylint_rc:
description: '.pylintrc configuration file'
default: '.pylintrc'
```
## Usage
```yaml
name: Pull Request
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
jobs:
linting:
runs-on: ubuntu-latest
steps:
- name: Black
uses: dciborow/[email protected]
with:
black: true
- name: Bandit
uses: dciborow/[email protected]
with:
bandit: true
- name: Pylint
uses: dciborow/[email protected]
with:
pylint: true
- name: Pyright
uses: dciborow/[email protected]
with:
pyright: true
- name: Flake8
uses: dciborow/[email protected]
with:
flake8: true
testing:
runs-on: ubuntu-latest
steps:
- name: Pytest
uses: dciborow/[email protected]
with:
testing: true
```
## Development
### Release
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
Pushing tag manually by yourself also work.
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
ref: https://help.github.com/en/articles/about-actions#versioning-your-action