Skip to content

Latest commit

 

History

History

lint

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
action.yaml
action.yaml
 
 

README.md

GitHub Action Lint

Description

GitHub Action that lints a python based repository

Usage

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

Inputs

name description required default
checkout-repo

Perform checkout as first step of action

 false true
github-token

GitHub token that can checkout the repository. e.g. 'secrets.GITHUB_TOKEN'

 true ""
release-notes

Whether to generate release notes for the pull request

 false true
s3-bucket-name

S3 bucket name to cache node_modules to speed up dependency installation.

 false ""
s3-bucket-region

S3 bucket region to cache node_modules to speed up dependency installation.

 false ""

Runs

This action is an composite action.

Lint Checks

This action runs the following lint checks:

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.