mirror of
https://github.com/vlang/v.git
synced 2023-08-10 21:13:21 +03:00
48 lines
1.2 KiB
YAML
48 lines
1.2 KiB
YAML
name: Docs CI
|
|
|
|
### Run on *EVERY* .v or .md related commit.
|
|
### The documentation *SHOULD* stay valid, and the developers should receive
|
|
### early warning, if they break it.
|
|
|
|
on:
|
|
push:
|
|
paths-ignore:
|
|
- "**.yml"
|
|
pull_request:
|
|
paths-ignore:
|
|
- "**.yml"
|
|
|
|
jobs:
|
|
check-markdown:
|
|
runs-on: ubuntu-20.04
|
|
timeout-minutes: 5
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Build V
|
|
run: make
|
|
- name: Check markdown line length & code examples
|
|
run: ./v check-md -hide-warnings .
|
|
## NB: -hide-warnings is used here, so that the output is less noisy,
|
|
## thus real errors are easier to spot.
|
|
|
|
report-missing-fn-doc:
|
|
runs-on: ubuntu-20.04
|
|
timeout-minutes: 5
|
|
env:
|
|
MOPTIONS: --relative-paths --exclude /vlib/v/ --exclude /builtin/linux_bare/ --exclude /testdata/ --exclude /tests/
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Build V
|
|
run: make
|
|
|
|
- name: Checkout previous v
|
|
uses: actions/checkout@v3
|
|
with:
|
|
repository: vlang/v
|
|
ref: master # important
|
|
path: pv
|
|
|
|
- name: Check against parent commit
|
|
run: |
|
|
./v missdoc --diff $MOPTIONS pv/vlib vlib
|