Skip to content

Setup lint workflow

Setup lint workflow #1

Workflow file for this run

# NOTE: This name appears in GitHub's Checks API and in workflow's status badge.
name: ci-lint
# Trigger the workflow when:
on:
# A push occurs to one of the matched branches.
push:
branches: [master]
# Or when a pull request event occurs for a pull request against one of the
# matched branches.
pull_request:
branches: [master]
jobs:
lint:
# NOTE: This name appears in GitHub's Checks API.
name: lint
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
# Checkout pull request HEAD commit instead of merge commit.
ref: ${{ github.event.pull_request.head.sha }}
# Fetch all history so gitlint can check the relevant commits.
fetch-depth: '0'
- name: Set up Python 3
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Set up Node.js 20
uses: actions/setup-node@v4
with:
node-version: '20.x'
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Install gitlint
run: |
python -m pip install gitlint
- name: Lint documentation
run: |
yarn lint-docs
# Always run this step so that all linting errors can be seen at once.
if: always()
- name: Lint git commits
run: |
yarn lint-git
# Always run this step so that all linting errors can be seen at once.
if: always()
- name: ESLint
# Disallow warnings and always throw errors.
run: yarn lint
# Always run this step so that all linting errors can be seen at once.
if: always()
- name: Validate TypeScript
run: yarn checkTs
# Always run this step so that all linting errors can be seen at once.
if: always()