mirror of
https://github.com/python/cpython.git
synced 2025-12-31 04:23:37 +00:00
GH-136155: Fail the EPUB check on fatal errors (#137351)
This commit is contained in:
parent
25518f51dc
commit
b4a1974aa2
2 changed files with 48 additions and 27 deletions
39
.github/workflows/reusable-docs.yml
vendored
39
.github/workflows/reusable-docs.yml
vendored
|
|
@ -75,18 +75,6 @@ jobs:
|
|||
--fail-if-regression \
|
||||
--fail-if-improved \
|
||||
--fail-if-new-news-nit
|
||||
- name: 'Build EPUB documentation'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
set -Eeuo pipefail
|
||||
make -C Doc/ PYTHON=../python SPHINXOPTS="--quiet" epub
|
||||
pip install epubcheck
|
||||
epubcheck Doc/build/epub/Python.epub &> Doc/epubcheck.txt
|
||||
- name: 'Check for fatal errors in EPUB'
|
||||
if: github.event_name == 'pull_request'
|
||||
continue-on-error: true # until gh-136155 is fixed
|
||||
run: |
|
||||
python Doc/tools/check-epub.py
|
||||
|
||||
# Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release
|
||||
doctest:
|
||||
|
|
@ -114,3 +102,30 @@ jobs:
|
|||
# Use "xvfb-run" since some doctest tests open GUI windows
|
||||
- name: 'Run documentation doctest'
|
||||
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXERRORHANDLING="--fail-on-warning" doctest
|
||||
|
||||
check-epub:
|
||||
name: 'Check EPUB'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
persist-credentials: false
|
||||
- name: 'Set up Python'
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3'
|
||||
cache: 'pip'
|
||||
cache-dependency-path: 'Doc/requirements.txt'
|
||||
- name: 'Install build dependencies'
|
||||
run: |
|
||||
make -C Doc/ venv
|
||||
python -m pip install epubcheck
|
||||
- name: 'Build EPUB documentation'
|
||||
run: make -C Doc/ PYTHON=../python epub
|
||||
- name: 'Run epubcheck'
|
||||
continue-on-error: true
|
||||
run: epubcheck Doc/build/epub/Python.epub &> Doc/epubcheck.txt
|
||||
- run: cat Doc/epubcheck.txt
|
||||
- name: 'Check for fatal errors in EPUB'
|
||||
run: python Doc/tools/check-epub.py
|
||||
|
|
|
|||
|
|
@ -1,24 +1,30 @@
|
|||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
CPYTHON_ROOT = Path(
|
||||
__file__, # cpython/Doc/tools/check-epub.py
|
||||
'..', # cpython/Doc/tools
|
||||
'..', # cpython/Doc
|
||||
'..', # cpython
|
||||
).resolve()
|
||||
EPUBCHECK_PATH = CPYTHON_ROOT / 'Doc' / 'epubcheck.txt'
|
||||
|
||||
|
||||
def main() -> int:
|
||||
wrong_directory_msg = "Must run this script from the repo root"
|
||||
if not Path("Doc").exists() or not Path("Doc").is_dir():
|
||||
raise RuntimeError(wrong_directory_msg)
|
||||
|
||||
with Path("Doc/epubcheck.txt").open(encoding="UTF-8") as f:
|
||||
messages = [message.split(" - ") for message in f.read().splitlines()]
|
||||
|
||||
fatal_errors = [message for message in messages if message[0] == "FATAL"]
|
||||
lines = EPUBCHECK_PATH.read_text(encoding='utf-8').splitlines()
|
||||
fatal_errors = [line for line in lines if line.startswith('FATAL')]
|
||||
|
||||
if fatal_errors:
|
||||
print("\nError: must not contain fatal errors:\n")
|
||||
for error in fatal_errors:
|
||||
print(" - ".join(error))
|
||||
err_count = len(fatal_errors)
|
||||
s = 's' * (err_count != 1)
|
||||
print()
|
||||
print(f'Error: epubcheck reported {err_count} fatal error{s}:')
|
||||
print()
|
||||
print('\n'.join(fatal_errors))
|
||||
return 1
|
||||
|
||||
return len(fatal_errors)
|
||||
print('Success: no fatal errors found.')
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
if __name__ == '__main__':
|
||||
raise SystemExit(main())
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue