1 | name: Docs CI |
2 | |
3 | ### Run on *EVERY* .v or .md related commit. |
4 | ### The documentation *SHOULD* stay valid, and the developers should receive |
5 | ### early warning, if they break it. |
6 | |
7 | on: |
8 | push: |
9 | paths-ignore: |
10 | - "**.yml" |
11 | pull_request: |
12 | paths-ignore: |
13 | - "**.yml" |
14 | |
15 | jobs: |
16 | check-markdown: |
17 | runs-on: ubuntu-20.04 |
18 | timeout-minutes: 5 |
19 | steps: |
20 | - uses: actions/checkout@v3 |
21 | - name: Build V |
22 | run: make |
23 | - name: Check markdown line length & code examples |
24 | run: ./v check-md -hide-warnings . |
25 | ## NB: -hide-warnings is used here, so that the output is less noisy, |
26 | ## thus real errors are easier to spot. |
27 | |
28 | report-missing-fn-doc: |
29 | runs-on: ubuntu-20.04 |
30 | timeout-minutes: 5 |
31 | env: |
32 | MOPTIONS: --relative-paths --exclude /vlib/v/ --exclude /builtin/linux_bare/ --exclude /testdata/ --exclude /tests/ |
33 | steps: |
34 | - uses: actions/checkout@v3 |
35 | - name: Build V |
36 | run: make |
37 | |
38 | - name: Checkout previous v |
39 | uses: actions/checkout@v3 |
40 | with: |
41 | repository: vlang/v |
42 | ref: master # important |
43 | path: pv |
44 | |
45 | - name: Check against parent commit |
46 | run: | |
47 | ./v missdoc --diff $MOPTIONS pv/vlib vlib |