mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
671f403602
* update docs pipeline to use poe task runner * move npm dependency into package.json file instead of hardcoding into pipeline * replace nix-specific call with python version (for windows compat) * update commands to use python for win compat * update lock file * change deps to take out xq and use xmltodict instead * move script tasks from pyproject into new tasks.py * run linting on new tasks.py file * fix typo * clean up pyproject to make valid toml * update docs with correct task runner command * use npx in case node_modules/.bin isn't in the path * Run pa11y-ci in cross-platform manner (works on Windows) * Add node_modules to .gitignore * clean up poe alias Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
72 lines
1.8 KiB
YAML
72 lines
1.8 KiB
YAML
# Copyright (C) 2012-2022 jrnl contributors
|
|
# License: https://www.gnu.org/licenses/gpl-3.0.html
|
|
|
|
name: Docs
|
|
|
|
on:
|
|
push:
|
|
branches: [ develop, release ]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'docs_theme/**'
|
|
- 'mkdocs.yml'
|
|
- 'readthedocs.yml'
|
|
- '.github/workflows/docs.yaml'
|
|
pull_request:
|
|
branches: [ develop ]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'docs_theme/**'
|
|
- 'mkdocs.yml'
|
|
- 'readthedocs.yml'
|
|
- '.github/workflows/docs.yaml'
|
|
|
|
jobs:
|
|
accessibility:
|
|
if: contains(toJson(github.event.commits), '[ci skip]') == false
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
fail-fast: true
|
|
matrix:
|
|
python-version: [ 3.9 ]
|
|
os: [ ubuntu-latest ]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v2
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
|
|
- name: Setup Node.js environment
|
|
uses: actions/setup-node@main
|
|
|
|
- name: Capture full Python version in env
|
|
run: echo "PYTHON_FULL_VERSION=$(python --version)" >> $GITHUB_ENV
|
|
|
|
- name: poetry cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: .venv
|
|
key: ${{ runner.os }}-${{ hashFiles('poetry.lock') }}-${{ env.PYTHON_FULL_VERSION }}-${{ secrets.CACHE_STRING }}
|
|
|
|
- name: npm cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: node_modules
|
|
key: ${{ runner.os }}-pa11y-v3
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install poetry
|
|
poetry config --local virtualenvs.in-project true
|
|
poetry install --no-root --remove-untracked
|
|
npm install
|
|
echo "node_modules/.bin" >> $GITHUB_PATH
|
|
|
|
- name: Start docs server
|
|
run: poetry run poe docs-run &
|
|
|
|
- name: Accessibility testing (Pa11y)
|
|
run: poetry run poe docs-check
|