Skip to content

Bypass reviewdog and install Vale directly #1967

Bypass reviewdog and install Vale directly

Bypass reviewdog and install Vale directly #1967

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
# Build pull requests
pull_request:
paths:
- 'docs/**'
- 'styles/**'
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.10']
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
- name: Create Python virtual environment
run: pip install virtualenv
- name: pip install requirements
run: |
pip install -r requirements-docs.txt
sudo snap install --edge vale
- name: Check for broken links
run: make docs-linkcheckbroken
- name: Build HTML documentation
run: make docs-html
- name: Run vale
run: |
git clone https://github.com/errata-ai/Microsoft.git
cp -r ./Microsoft/Microsoft ./styles
VALEFILES=$(find -L ./docs/ -type d -prune -false -o -type f -name "*.md" -print)
vale --no-exit $VALEFILES
# Disable GHA vale checking, it started to fail with a gazillion of
# violations. We need to review it closely
# - uses: errata-ai/vale-action@reviewdog
# with:
# # debug: true
# files: all
# env:
# # Required, set by GitHub actions automatically:
# # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
# GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}