mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-17 11:38:32 +02:00
update docs pipeline to use poe task runner
This commit is contained in:
parent
33607acbb6
commit
9a785e4cfd
2 changed files with 32 additions and 18 deletions
19
.github/workflows/docs.yaml
vendored
19
.github/workflows/docs.yaml
vendored
|
@ -66,22 +66,7 @@ jobs:
|
||||||
echo "node_modules/.bin" >> $GITHUB_PATH
|
echo "node_modules/.bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
- name: Start docs server
|
- name: Start docs server
|
||||||
run: poetry run poe docs &
|
run: poetry run poe docs-run &
|
||||||
|
|
||||||
- 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)
|
- name: Accessibility testing (Pa11y)
|
||||||
run: pa11y-ci -c list.json
|
run: poetry run poe docs-check-ci
|
||||||
|
|
|
@ -61,6 +61,14 @@ yq = "*"
|
||||||
jrnl = 'jrnl.cli:cli'
|
jrnl = 'jrnl.cli:cli'
|
||||||
|
|
||||||
[tool.poe.tasks]
|
[tool.poe.tasks]
|
||||||
|
script-clean-docs.shell = "rm -fv sitemap.xml list.json"
|
||||||
|
script-generate-sitemap.shell = 'curl -s "127.0.0.1:8000/sitemap.xml" > sitemap.xml'
|
||||||
|
script-generate-page-list-from-sitemap.shell = '''
|
||||||
|
select='{urls: ["http://127.0.0.1:8000/", "http://127.0.0.1:8000/search.html?q=jrnl", .urlset.url[].loc]}'
|
||||||
|
poetry run xq "$select" sitemap.xml > list.json
|
||||||
|
'''
|
||||||
|
script-run-pa11y.cmd = "pa11y-ci -c list.json"
|
||||||
|
|
||||||
format-run = [
|
format-run = [
|
||||||
{cmd = "black ."},
|
{cmd = "black ."},
|
||||||
]
|
]
|
||||||
|
@ -79,7 +87,28 @@ sort-check = [
|
||||||
{cmd = "isort --version"},
|
{cmd = "isort --version"},
|
||||||
{cmd = "isort --check ."},
|
{cmd = "isort --check ."},
|
||||||
]
|
]
|
||||||
# docs-check = ?
|
docs-check = [
|
||||||
|
"script-clean-docs",
|
||||||
|
"script-generate-sitemap",
|
||||||
|
"script-generate-page-list-from-sitemap",
|
||||||
|
"script-run-pa11y",
|
||||||
|
"script-clean-docs",
|
||||||
|
]
|
||||||
|
docs-check-ci = [
|
||||||
|
"script-generate-sitemap",
|
||||||
|
{shell = '''
|
||||||
|
echo "::group::sitemap.xml"
|
||||||
|
cat sitemap.xml
|
||||||
|
echo '::endgroup::'
|
||||||
|
'''},
|
||||||
|
"script-generate-page-list-from-sitemap",
|
||||||
|
{shell = '''
|
||||||
|
echo "::group::list.json"
|
||||||
|
cat list.json
|
||||||
|
echo '::endgroup::'
|
||||||
|
'''},
|
||||||
|
"script-run-pa11y",
|
||||||
|
]
|
||||||
docs-run = [
|
docs-run = [
|
||||||
{cmd = "mkdocs serve"},
|
{cmd = "mkdocs serve"},
|
||||||
]
|
]
|
||||||
|
|
Loading…
Add table
Reference in a new issue