Skip to content

Commit 378f2ae

Browse files
rustyconoverclaude
andcommitted
ci: disable Cloudflare Pages deploy; give lychee a root dir
- docs.yml: drop the Cloudflare Pages deploy (hosting is moving to a different approach) and park the workflow as manual-only (workflow_dispatch). It now just builds the site; CI already validates docs build/examples/prose/links on every push. Re-add a deploy step when the new hosting path is decided. - ci.yml: pass `--root-dir <workspace>/docs` to lychee so root-relative links like the kind-banner `<img src="/assets/kinds/*.svg">` (mkdocs serves them from the site root = docs/) resolve in offline checking. Fixes the 5 link errors in docs/how-to/function-patterns.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7165b99 commit 378f2ae

2 files changed

Lines changed: 9 additions & 20 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ jobs:
109109
- name: Link check (lychee)
110110
uses: lycheeverse/lychee-action@v2
111111
with:
112-
args: "--no-progress --offline docs/**/*.md *.md"
112+
# --root-dir resolves root-relative links (e.g. <img src="/assets/...">,
113+
# which mkdocs serves from the site root = docs/) for offline checking.
114+
args: "--no-progress --offline --root-dir ${{ github.workspace }}/docs docs/**/*.md *.md"
113115
fail: true
114116

115117
s3-offload-localstack:

‎.github/workflows/docs.yml‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
11
name: Docs
22

3+
# Cloudflare Pages deploy is disabled for now — docs hosting is moving to a
4+
# different approach. This workflow is manual-only (workflow_dispatch) and just
5+
# builds the site as a check; the CI workflow already validates the docs build
6+
# (strict), examples, prose, and links on every push. Re-add a deploy step here
7+
# (or a new workflow) once the new hosting path is decided.
38
on:
4-
push:
5-
branches: [main]
6-
paths:
7-
- "docs/**"
8-
- "mkdocs.yml"
9-
- "vgi/**"
10-
- "pyproject.toml"
119
workflow_dispatch:
1210

1311
permissions:
1412
contents: read
1513

16-
concurrency:
17-
group: pages
18-
cancel-in-progress: true
19-
2014
jobs:
21-
deploy:
15+
build:
2216
runs-on: ubuntu-latest
2317
steps:
2418
- uses: actions/checkout@v5
@@ -37,10 +31,3 @@ jobs:
3731

3832
- name: Build docs
3933
run: uv run mkdocs build --strict
40-
41-
- name: Deploy to Cloudflare Pages
42-
uses: cloudflare/wrangler-action@v3
43-
with:
44-
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
45-
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
46-
command: pages deploy site --project-name=vgi-python-docs --commit-dirty=true

0 commit comments

Comments
 (0)