6adaf56c73
* added value rules * resolved errors raised by vale * added github action * fixes to github action * added details in contribution guidelines * added rule for numbers * limited checks to errors
62 lines
1.4 KiB
YAML
62 lines
1.4 KiB
YAML
name: Documentation Tests
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- docs/content/**
|
|
- www/docs/**
|
|
jobs:
|
|
docs-test:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.9.1
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v2.3.5
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Node.js environment
|
|
uses: actions/setup-node@v2.4.1
|
|
with:
|
|
node-version: "16"
|
|
cache: "yarn"
|
|
|
|
- name: Install dependencies
|
|
uses: ./.github/actions/cache-deps
|
|
with:
|
|
extension: docs
|
|
|
|
- name: Build Docusaurus website
|
|
run: |
|
|
cd www/docs
|
|
yarn install
|
|
yarn build
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.9.1
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v2.3.5
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Get Directories to Scan
|
|
working-directory: docs
|
|
run: ./get-files.sh
|
|
id: directories
|
|
|
|
- name: Vale Linter
|
|
uses: errata-ai/vale-action@reviewdog
|
|
with:
|
|
files: ${{ steps.directories.outputs.LIST }}
|
|
fail_on_error: true
|
|
vale_flags: '--minAlertLevel=error'
|
|
env:
|
|
GITHUB_TOKEN: ${{ github.token }} |