Update .gitattributes #18
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| - name: Python Actions Collection | ||
| uses: microsoft/[email protected] | ||
| inputs: | ||
| black: | ||
| description: | | ||
| Run Black | ||
| Default is false. | ||
| default: true | ||
| bandit: | ||
| description: | | ||
| Run Bandit | ||
| Default is false. | ||
| default: true | ||
| pylint: | ||
| description: | | ||
| Run Pylint | ||
| Default is false. | ||
| default: true | ||
| pyright: | ||
| description: | | ||
| Run Pyright | ||
| Default is false. | ||
| default: true | ||
| flake8: | ||
| description: | | ||
| Run Flake8 | ||
| Default is false. | ||
| default: true | ||
| testing: | ||
| description: | | ||
| Run tests with PyTest | ||
| Default is false. | ||
| default: true | ||
| 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' | ||
| 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 | ||
| name: 'Python Actions Collection' | ||
| description: 'Run actions for Python Project on pull requests to improve code review experience.' | ||
| author: 'dciborow' | ||
| inputs: | ||
| # Python Project Configuration is expected to be in a pyproject.toml | ||
| root: | ||
| description: | | ||
| Project root directory. | ||
| Default '.' | ||
| default: '.' | ||
| toml: | ||
| description: | | ||
| pyproject.toml location. | ||
| Default pyproject.toml | ||
| default: 'pyproject.toml' | ||
| # Python Tooling | ||
| black: | ||
| description: | | ||
| Run Black | ||
| Default is false. | ||
| default: true | ||
| bandit: | ||
| description: | | ||
| Run Bandit | ||
| Default is false. | ||
| default: true | ||
| pylint: | ||
| description: | | ||
| Run Pylint | ||
| Default is false. | ||
| default: true | ||
| pyright: | ||
| description: | | ||
| Run Pyright | ||
| Default is false. | ||
| default: true | ||
| flake8: | ||
| description: | | ||
| Run Flake8 | ||
| Default is false. | ||
| default: true | ||
| pytest: | ||
| description: | | ||
| Run tests with PyTest | ||
| Default is false. | ||
| default: true | ||
| pypi_publish: | ||
| description: | | ||
| Publish to PyPi | ||
| Default is false | ||
| default: false | ||
| # Advanced Settings | ||
| args: | ||
| description: | | ||
| Customize which tests run with Pytest Markers | ||
| default: '' | ||
| pypi_repo: | ||
| description: | | ||
| PyPi Target. Use this to point to private or test locations. | ||
| Default testpypi | ||
| default: 'pypi' | ||
| pypi_password: | ||
| description: | | ||
| Credentials for PyPi | ||
| default: '' | ||
| version_suffix: | ||
| description: | | ||
| Value to append to version in order to produce unique id for PyPi. | ||
| Examples include: | ||
| '-rc {{ github.run_attempt }}' | ||
| '-dev {{ github.run_attempt }}' | ||
| default: '' | ||
| 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: '' | ||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - if: ${{ inputs.black == 'true' }} | ||
| uses: rickstaa/action-black@v1 | ||
| id: action_black | ||
| with: | ||
| black_args: "--config ${{ inputs.root }}/${{ inputs.toml }} ${{ inputs.root }}/${{ inputs.workdir }} ${{ inputs.root }}/tests" | ||
| - if: steps.action_black.outputs.is_formatted == 'true' | ||
| uses: reviewdog/action-suggester@v1 | ||
| with: | ||
| tool_name: blackfmt | ||
| fail_on_error: true | ||
| - if: ${{ inputs.bandit == 'true' }} | ||
| uses: dciborow/[email protected] | ||
| with: | ||
| workdir: ${{ inputs.root }} | ||
| - if: ${{ inputs.flake8 == 'true' }} | ||
| uses: reviewdog/action-flake8@v3 | ||
| with: | ||
| github_token: ${{ inputs.github_token }} | ||
| workdir: ${{ inputs.root }}/${{ inputs.workdir }} | ||
| - if: ${{ inputs.pylint == 'true' }} | ||
| uses: dciborow/[email protected] | ||
| with: | ||
| github_token: ${{ inputs.github_token }} | ||
| workdir: ${{ inputs.root }}/${{ inputs.workdir }} | ||
| - if: ${{ inputs.pyright == 'true' }} | ||
| uses: jakebailey/[email protected] | ||
| with: | ||
| working-directory: ${{ inputs.root }} | ||
| project: ${{ inputs.toml }} | ||
| - if: ${{ inputs.pytest == 'true' || inputs.pypi_publish == 'true' }} | ||
| uses: actions/setup-python@v1 | ||
| with: | ||
| python-version: '3.7' | ||
| - if: ${{ inputs.pytest == 'true' }} | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| python -m pip install pytest flit | ||
| cd "${{ inputs.root }}" | ||
| python -m flit install | ||
| python -m pytest '${{ inputs.args }}' tests | ||
| shell: bash | ||
| - if: ${{ inputs.pypi_publish == 'true' }} | ||
| run: | | ||
| cd "${{ inputs.root }}" | ||
| python -m pip install --upgrade pip | ||
| python -m pip install flit | ||
| sed -i -r 's/[0-9]\.[0-9]\.[0-9]+/&${{ inputs.version_suffix }}/g' src/*/__init__.py | ||
| python -m flit publish $repository --repository ${{ inputs.pypi_repo }} --pypirc .pypirc | ||
| env: | ||
| FLIT_USERNAME: __token__ | ||
| FLIT_PASSWORD: ${{ inputs.pypi_password }} | ||
| shell: bash | ||
| # Ref: https://haya14busa.github.io/github-action-brandings/ | ||
| branding: | ||
| icon: 'check' | ||
| color: 'blue' | ||
