Skip to content

Commit 1810bd2

Browse files
committed
CI: Test docs/errors/
Make sure the files in docs/errors/ contain good examples. (The first example should have the documented error, and subsequent examples should have no errors.)
1 parent f95cf49 commit 1810bd2

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Copyright (C) 2020 Matthew Glazar
2+
# See end of file for extended copyright information.
3+
4+
name: check error docs
5+
on:
6+
push:
7+
pull_request:
8+
types: [opened, synchronize]
9+
10+
jobs:
11+
check_format:
12+
name: check error docs
13+
runs-on: ubuntu-18.04
14+
container: ghcr.io/quick-lint/quick-lint-js-github-builder:v1
15+
steps:
16+
- if: ${{ github.event_name == 'push' }}
17+
uses: actions/checkout@v2
18+
- if: ${{ github.event_name == 'pull_request' }}
19+
uses: actions/checkout@v2
20+
with:
21+
ref: ${{ github.event.pull_request.head.sha }}
22+
23+
- name: configure
24+
run: CC=gcc-8 CXX=g++-8 cmake -DBUILD_TESTING=NO -S . -B build
25+
- name: build
26+
run: cmake --build build --config Debug
27+
- name: generate docs
28+
run: ./build/docs/quick-lint-js-generate-error-docs docs/errors/ website/errors/index.template.html website/errors/index.html
29+
30+
# quick-lint-js finds bugs in JavaScript programs.
31+
# Copyright (C) 2020 Matthew Glazar
32+
#
33+
# This file is part of quick-lint-js.
34+
#
35+
# quick-lint-js is free software: you can redistribute it and/or modify
36+
# it under the terms of the GNU General Public License as published by
37+
# the Free Software Foundation, either version 3 of the License, or
38+
# (at your option) any later version.
39+
#
40+
# quick-lint-js is distributed in the hope that it will be useful,
41+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
42+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43+
# GNU General Public License for more details.
44+
#
45+
# You should have received a copy of the GNU General Public License
46+
# along with quick-lint-js. If not, see <https://www.gnu.org/licenses/>.

0 commit comments

Comments
 (0)