master
1# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
2#
3# SPDX-License-Identifier: curl
5# This workflow contains tests that operate on documentation files only. Some
6# checks modify the source so they cannot be combined into a single job.
8name: 'Docs'
10'on':
11 push:
12 branches:
13 - master
14 - 'curl-*'
15 - '*/ci'
16 paths:
17 - '.github/workflows/checkdocs.yml'
18 - '.github/scripts/**'
19 - 'scripts/**'
20 - '**.md'
21 - 'docs/*'
22 pull_request:
23 branches:
24 - master
25 - 'curl-*'
26 paths:
27 - '.github/workflows/checkdocs.yml'
28 - '.github/scripts/**'
29 - 'scripts/**'
30 - '**.md'
31 - 'docs/*'
33concurrency:
34 group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
35 cancel-in-progress: true
37permissions: {}
38cache-mode: none
40env:
41 DO_NOT_TRACK: '1'
43jobs:
44 # config file help: https://github.com/amperser/proselint/
45 proselint:
46 name: 'proselint'
47 runs-on: ubuntu-26.04-arm
48 steps:
49 - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
50 with:
51 persist-credentials: false
53 - name: 'trim headers off all *.md files'
54 background: true
55 run: git ls-files '*.md' -z | xargs -0 -n1 .github/scripts/trimmarkdownheader.pl
57 - name: 'install prereqs'
58 uses: $/.github/actions/pkg-install
59 with:
60 pip: -r .github/scripts/requirements-proselint.txt
62 - name: 'trim headers off all *.md files'
63 wait-all:
65 - name: 'check special prose' # For CHECKSRC and files with aggressive exclamation mark needs
66 background: true
67 run: |
68 cat <<JSON > ~/.proselintrc-special.json
69 {
70 "checks": {
71 "annotations.misc": false,
72 "lexical_illusions": false,
73 "typography.diacritical_marks": false,
74 "typography.punctuation.exclamation": false,
75 "typography.symbols": false
76 }
77 }
78 JSON
79 source ~/venv/bin/activate
80 proselint check --config ~/.proselintrc-special.json docs/internals/CHECKSRC.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md
82 - name: 'check prose'
83 run: |
84 cat <<JSON > ~/.proselintrc-base.json
85 {
86 "checks": {
87 "annotations.misc": false,
88 "lexical_illusions": false,
89 "misc.annotations": false,
90 "redundancy.misc.garner": false,
91 "security.password": false,
92 "spelling.ve_of": false,
93 "typography.diacritical_marks": false,
94 "typography.symbols": false
95 }
96 }
97 JSON
98 source ~/venv/bin/activate
99 git ls-files README '*.md' -z | grep -Evz '(CHECKSRC|DISTROS|CURLOPT_INTERFACE|interface)\.md' | xargs -0 proselint check --config ~/.proselintrc-base.json --
101 pyspelling:
102 name: 'pyspelling'
103 runs-on: ubuntu-26.04-arm
104 steps:
105 - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
106 with:
107 persist-credentials: false
109 - name: 'trim all *.md files in docs/'
110 background: true
111 run: .github/scripts/cleancmd.pl 'docs/*.md'
113 - name: 'install prereqs'
114 timeout-minutes: 2
115 uses: $/.github/actions/pkg-install
116 with:
117 apt: aspell aspell-en
118 pip: -r .github/scripts/requirements-docs.txt
120 - name: 'trim all *.md files in docs/'
121 wait-all:
123 - name: 'check spelling'
124 run: |
125 source ~/venv/bin/activate
126 # setup the custom wordlist
127 grep -v '^#' .github/scripts/pyspelling.words > wordlist.txt
128 aspell --version
129 pyspelling --version
130 pyspelling --verbose --jobs 5 --config .github/scripts/pyspelling.yaml
132 synopsis-man-examples:
133 name: 'synopsis, man-examples'
134 runs-on: ubuntu-26.04-arm
135 steps:
136 - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
137 with:
138 persist-credentials: false
140 - name: 'verify synopsis'
141 background: true
142 run: .github/scripts/verify-synopsis.pl docs/libcurl/curl*.md
144 - name: 'verify examples (gcc)'
145 background: true
146 run: |
147 cmake -B bld-gcc -G Ninja -D_CURL_PREFILL=ON -DCURL_USE_LIBPSL=OFF -DCURL_WERROR=ON -D_CURL_SAVE_PICKY_OPTIONS=ON
148 export CFLAGS; CFLAGS="$(cat bld-gcc/picky-options.txt)"
149 echo "${CFLAGS}"
150 .github/scripts/verify-examples.pl docs/libcurl/curl*.md docs/libcurl/opts/*.md
152 - name: 'verify examples (clang)'
153 run: |
154 export CC=clang
155 cmake -B bld-clang -G Ninja -D_CURL_PREFILL=ON -DCURL_USE_LIBPSL=OFF -DCURL_WERROR=ON -D_CURL_SAVE_PICKY_OPTIONS=ON
156 export CFLAGS; CFLAGS="$(cat bld-clang/picky-options.txt)"
157 echo "${CFLAGS}"
158 .github/scripts/verify-examples.pl docs/libcurl/curl*.md docs/libcurl/opts/*.md
Diagnostics4 git calls · 47 ms
CallStatusSizeTime047 ms
discover200152 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=152 git.server.agent=gitty/1.0 git.server.object_format=sha1 git.server.caps=agent ls-refs fetch object-format git.server.fetch=shallow filter sideband-all git.protocol.version=2 git.pkt.frames=8 git.pkt.data=6 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=152 git.pkt.payload.max=34
ls-refs200149 B · hit2 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=149 git.response.cache=HIT git.response.duration_ms=2 git.protocol.version=2 git.pkt.frames=3 git.pkt.data=2 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=149 git.pkt.payload.max=78 git.ls_refs.count=2 git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=293470 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=blob:none git.fetch.filter.requested=tree:0 git.fetch.filter.fallback=blob:none git.fetch.filter.learned=false git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=10 git.pkt.data=8 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=293470 git.pkt.payload.max=65516 git.sideband.band1.bytes=293354 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=87 git.pack.bytes=293354 git.pack.ofs_delta=0 git.pack.ref_delta=1 git.pack.chain.max=1 git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0 git.pack.full=86Open pack map
fetch2001.6 KiB · hit41 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=41 git.response.bytes=1615 git.response.cache=HIT git.response.duration_ms=41 git.fetch.wants=d6031d59598a9faaed322b97b537fe7ce3164213 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=3 git.pkt.data=2 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1615 git.pkt.payload.max=1594 git.sideband.band1.bytes=1593 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
- Ref
- refs/heads/master
- Commit
- 31c911efe5652725e930f4d2e60c9060e5f6646d
- cf-ray
- a5e1edd82d3defe9
- Request
- 84de5bdb…
- Protocol
- v2 · sha1
- Agent
- gitty/1.0
- Filter
- advertised
- Fetch
- shallow filter sideband-all
- Capabilities
- agent ls-refs fetch object-format