First attempt to add Doctor-RST #942
Workflow file for this run
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: Linting | |
on: | |
pull_request: | |
jobs: | |
prose: | |
runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading | |
permissions: | |
contents: read | |
pull-requests: write | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.x' | |
cache: 'pip' | |
- name: Install Python dependencies | |
run: pip3 install -r docs/requirements.txt | |
- name: Vale | |
uses: errata-ai/vale-action@reviewdog | |
with: | |
# Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience | |
version: 3.7.1 | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.x' | |
cache: 'pip' | |
- name: Install Python dependencies | |
run: pip3 install -r docs/requirements.txt | |
- name: Build docs | |
working-directory: docs | |
run: make html | |
- name: Check links | |
working-directory: docs | |
run: make checklinks | |
doctor_rst: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Create cache dir | |
run: mkdir .cache | |
- name: Extract base branch name | |
run: echo "##[set-output name=branch;]$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})" | |
id: extract_base_branch | |
- name: Cache DOCtor-RST | |
uses: actions/cache@v2 | |
with: | |
path: .cache | |
key: doctor-rst-${{ runner.os }}-${{ steps.extract_base_branch.outputs.branch }} | |
restore-keys: | | |
doctor-rst-${{ runner.os }}- | |
doctor-rst- | |
- name: Run DOCtor-RST | |
uses: docker://oskarstark/doctor-rst | |
with: | |
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache | |
env: | |
DOCS_DIR: 'docs/' |