Skip to content
Pull request pipeline

Remove appendices #143

Sign in to view logs

Remove appendices

Remove appendices #143

Workflow file for this run

.github/workflows/pr.yaml at c146794
name: Pull request pipeline
on:
pull_request:
branches:
- main
workflow_dispatch:
# for security reasons the github actions are pinned to specific release versions
jobs:
link_checker:
name: Link checker
runs-on: ubuntu-24.04
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Link Checker
uses: lycheeverse/[email protected]
with:
args: >-
--no-progress
--max-retries 1
--retry-wait-time 10
--max-concurrency 2
'**/*.md'
'*.md'
fail: true
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
md_linter:
name: Lint markdown
runs-on: ubuntu-24.04
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Lint markdown
uses: DavidAnson/[email protected]
with:
config: '.markdownlint.yaml'
globs: |
docs/**/*.md
docs/*.md
*.md
spell_checker_en:
name: Check EN spelling
runs-on: ubuntu-24.04
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Spell check EN language
uses: rojopolis/[email protected]
with:
config_path: .spellcheck-en.yaml
spell_checker_es:
name: Check ES spelling
runs-on: ubuntu-24.04
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Spell check ES language
uses: rojopolis/[email protected]
with:
config_path: .spellcheck-es.yaml
spell_checker_pt-br:
name: Check PT-BR spelling
runs-on: ubuntu-24.04
steps:
- name: Checkout markdown
uses: actions/[email protected]
# rojopolis/spellcheck-github-actions does not support PT-BR,
# only PT, and PT-BR is too different to pass a PT spellcheck
- name: Set up Python
uses: actions/[email protected]
with:
python-version: '3.10'
- name: Install pyspelling
run: |
python -m pip install --upgrade pip setuptools
python -m pip install pyspelling
sudo apt-get install aspell aspell-pt
- name: Spell check PT-BR release
run: |
python -m pyspelling --config .spellcheck-pt-br.yaml
build_check:
name: Build check
runs-on: ubuntu-24.04
needs: [md_linter, spell_checker_en, spell_checker_es, spell_checker_pt-br]
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Install python
uses: actions/[email protected]
with:
python-version: 3.x
- name: Install python packages
run: |
python -m pip install --upgrade pip setuptools wheel
pip install mkdocs
pip install mkdocs-material
pip install mkdocs-open-in-new-tab
pip install mkdocs-with-pdf
- name: Copy contributing tab files
run: |
cp code_of_conduct.md docs/.
cp contributing.md docs/.
cp license.txt docs/.
- name: Build docs
run: mkdocs build
export_pdf:
name: Export PDFs
runs-on: ubuntu-24.04
needs: [build_check]
steps:
- name: Checkout markdown
uses: actions/[email protected]
- name: Install python
uses: actions/[email protected]
with:
python-version: 3.x
- name: Install python packages
run: |
python -m pip install --upgrade pip setuptools wheel
pip install mkdocs
pip install mkdocs-material
pip install mkdocs-open-in-new-tab
pip install mkdocs-with-pdf
- name: Build pdf for EN
run: mkdocs build --config-file mkdocs-pdf-en.yaml
- name: Build pdf for ES
run: mkdocs build --config-file mkdocs-pdf-es.yaml
- name: Build pdf for FA
run: mkdocs build --config-file mkdocs-pdf-fa.yaml
- name: Build pdf for PT-BR
run: mkdocs build --config-file mkdocs-pdf-pt-br.yaml