2020-10-20 20:14:56 +02:00
|
|
|
name: Docs CI
|
|
|
|
|
|
2020-11-27 10:52:56 +01:00
|
|
|
### Run on *EVERY* commit. The documentation *SHOULD* stay valid, and
|
|
|
|
|
### the developers should receive early warning if they break it.
|
|
|
|
|
on: [push, pull_request]
|
2020-10-20 20:14:56 +02:00
|
|
|
|
|
|
|
|
jobs:
|
2020-11-18 18:28:28 +01:00
|
|
|
check-markdown:
|
2020-10-20 20:14:56 +02:00
|
|
|
runs-on: ubuntu-18.04
|
2020-11-19 09:36:30 +01:00
|
|
|
timeout-minutes: 5
|
2020-10-20 20:14:56 +02:00
|
|
|
steps:
|
|
|
|
|
- uses: actions/checkout@v2
|
|
|
|
|
- name: Build V
|
|
|
|
|
run: make
|
2020-11-18 18:28:28 +01:00
|
|
|
- name: Check markdown line length & code examples
|
2021-02-05 16:46:20 +01:00
|
|
|
run: ./v check-md -hide-warnings .
|
2021-01-10 14:58:45 +01:00
|
|
|
## NB: -hide-warnings is used here, so that the output is less noisy,
|
|
|
|
|
## thus real errors are easier to spot.
|
