Install the CodeSee workflow. Learn more at https://docs.codesee.io #1
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: Lint Yaml | |
# **What it does**: This lints our yaml files in the docs repository. | |
# **Why we have it**: We want some level of consistent formatting for YAML files. | |
# **Who does it impact**: Docs engineering, docs content. | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
paths: | |
- '**/*.yml' | |
- '**/*.yaml' | |
pull_request: | |
paths: | |
- '**/*.yml' | |
- '**/*.yaml' | |
jobs: | |
lint: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repo | |
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f | |
- name: Setup node | |
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e | |
with: | |
node-version: 16.x | |
- name: Get npm cache directory | |
id: npm-cache | |
run: | | |
echo "::set-output name=dir::$(npm config get cache)" | |
- name: Cache node modules | |
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a | |
with: | |
path: ${{ steps.npm-cache.outputs.dir }} | |
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
restore-keys: | | |
${{ runner.os }}-node- | |
- name: Install dependencies | |
run: npm ci | |
- name: Run linter | |
run: npx prettier -c "**/*.{yml,yaml}" |