Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.47 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.47 KB
Raw

GitHub Action Lint

Description

GitHub Action that lints a python based repository

Usage

jobs:
  build:
    steps:
      - name: Lint
        uses: armand-sauzay/actions-python/lint@v1
        with:
          ## example value for github-token provided below
          github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

parameter description required default
checkout-repo Perform checkout as first step of action false true
pypi-token PyPI token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.PYPI_TOKEN' false
github-token GitHub token that can checkout the repository. e.g. 'secrets.GITHUB_TOKEN' true ${{ github.token }}

Runs

This action is an composite action.

Lint Checks

This action runs pre-commit.

Notes

  • By default, this action will perform actions/checkout as its first step.
  • This expects that .commitlintrc.yaml will be present to enforce conventional-commit.