Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.03 KB

README.md

File metadata and controls

62 lines (46 loc) · 2.03 KB

GitHub Action Lint

Description

GitHub Action that runs lint on a GitHub Action

Usage

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

Lint Checks

This action runs the following lint checks:

Notes

  • By default, this action will perform actions/checkout as its first step.
  • If the consumer repository has a package-lock.json
    • It will execute npm ci before running the pre-commit step.
    • It will run the check-build action.
  • This expects that .commitlintrc.yaml will be present at the root level of the consumer repository to enforce conventional-commit.

Inputs

parameter description required default
checkout-repo Perform checkout as first step of action false true
github-token GitHub token that can create/delete comments. Usually - 'secrets.GITHUB_TOKEN' true
node-version Node version to use false 18
semantic-release-extra-plugins Extra plugins for pre-install when linting the release notes. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config. false @open-turo/semantic-release-config

Runs

This action is a composite action.