Skip to content

Add Custom Markdown Lint #226

Add Custom Markdown Lint

Add Custom Markdown Lint #226

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: CI
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
lint:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run markdown lint
run: |
npm install remark-cli remark-preset-lint-consistent
npx remark . --use remark-preset-lint-consistent --frail
- uses: actions/upload-artifact@v3
with:
name: remark-lint-report
path: public/
custom_md_lint:
runs-on: ubuntu-latest
steps:
- uses: action/checkout@v4
- uses: action/setup-node@v4
with:
node-version: '14'
- name: Run custom markdown validation
run: node .github/scripts/validateReadme.js