mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
7dccc469b5
* Get rid of `make` in favor of `poe` This moves the tasks that were previously in Makefile, into pyproject.toml (with all the other config) This is also more inclusive of Windows developers since they only need Python, and no longer have to install make separately. * update docs * don't make code blocks also links * implement tox for testing * update command to use new task runner
87 lines
2.2 KiB
YAML
87 lines
2.2 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 pa11y-ci
|
|
echo "node_modules/.bin" >> $GITHUB_PATH
|
|
|
|
- name: Start docs server
|
|
run: poetry run poe docs &
|
|
|
|
- name: Generate sitemap
|
|
env:
|
|
site_url: http://127.0.0.1:8000
|
|
run: |
|
|
filename='sitemap.xml'
|
|
select="{urls: [\"${site_url}/\", \"${site_url}/search.html?q=jrnl\", .urlset.url[].loc]}"
|
|
|
|
curl -s "${site_url}/${filename}" > $filename
|
|
|
|
echo "::group::${filename}"
|
|
cat $filename
|
|
echo '::endgroup::'
|
|
|
|
poetry run xq "$select" $filename > list.json
|
|
|
|
- name: Accessibility testing (Pa11y)
|
|
run: pa11y-ci -c list.json
|