tools: move cmd/tools/vdoc/doc
to cmd/tools/vdoc/document
, so that it can be imported from other programs through -path
, without conflicting with the top level doc/
folder in the main repo
#36049
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' | |
- '!**/docs_ci.yml' | |
- 'cmd/tools/vrepl.v' | |
pull_request: | |
paths-ignore: | |
- '**.yml' | |
- '!**/docs_ci.yml' | |
- 'cmd/tools/vrepl.v' | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/master' && github.sha || github.ref }} | |
cancel-in-progress: true | |
jobs: | |
check-markdown: | |
runs-on: ubuntu-20.04 | |
timeout-minutes: 5 | |
steps: | |
- uses: actions/checkout@v4 | |
- 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: --diff --deprecated --relative-paths --exclude /vlib/v/ --exclude /builtin/linux_bare/ --exclude /testdata/ --exclude /tests/ | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Build V | |
run: make | |
- name: Checkout previous v | |
uses: actions/checkout@v4 | |
with: | |
repository: vlang/v | |
ref: master # important | |
path: pv | |
- name: Check against parent commit | |
run: | | |
./v missdoc $MOPTIONS pv/vlib vlib |