Skip to content

Commit 6527562

Browse files
author
Fabian Baumeister
committed
Add workflow to detect errors in the antora files
Currently errors in the antora build are detected earliest at the stage of the final build in the website. Actually, that's to late for a developer to respond. The error on the page build should occur as early as possible during the PR. Therefor, this PR commits a new workflow that just builds the website. Using the loglevel definition during the build leads to the build returning an exit status code in case any errors occur.
1 parent 8b34592 commit 6527562

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

.github/workflows/check_build.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: check-build
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
jobs:
9+
check-antora:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: npm install for antora-cli
13+
run: |
14+
npm install
15+
16+
- name: Build Antora
17+
run: |
18+
npm run build

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"scripts": {
3-
"build": "npx antora ./antora-playbook.yml",
3+
"build": "npx antora --log-failure-level=error ./antora-playbook.yml",
44
"dev:server": "npx http-server build/site/ -c-1 -p 5000"
55
},
66
"devDependencies": {

0 commit comments

Comments
 (0)