Remove legacy Sphinx docs/ and finish the Mintlify cutover (#28964)
This commit is contained in:
+18
-24
@@ -13,29 +13,6 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Reject changes under legacy docs/
|
||||
if: github.event_name == 'pull_request'
|
||||
run: |
|
||||
set -euo pipefail
|
||||
BASE_REF="${{ github.base_ref }}"
|
||||
# Refresh origin/<base_ref> with full history; --depth=1 would
|
||||
# shallow the ref and break the merge-base used by `...`.
|
||||
git fetch --no-tags origin "$BASE_REF"
|
||||
# First, verify the diff itself succeeds and check whether any
|
||||
# files changed. A silent failure here would let docs/ changes
|
||||
# through, so the explicit `if !` guard is important.
|
||||
if ! CHANGED=$(git diff --name-only --diff-filter=ACMRDTUXB "origin/${BASE_REF}...HEAD"); then
|
||||
echo "git diff origin/${BASE_REF}...HEAD failed; aborting." >&2
|
||||
exit 2
|
||||
fi
|
||||
if [ -z "$CHANGED" ]; then
|
||||
echo "No changed files vs origin/${BASE_REF}; skipping."
|
||||
exit 0
|
||||
fi
|
||||
# Re-emit with -z so xargs can safely handle whitespace in paths.
|
||||
git diff -z --name-only --diff-filter=ACMRDTUXB "origin/${BASE_REF}...HEAD" \
|
||||
| xargs -0 python3 scripts/ci/check_no_docs_changes.py
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
@@ -52,7 +29,24 @@ jobs:
|
||||
- name: Run lychee docs checks (offline references)
|
||||
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
|
||||
with:
|
||||
args: --config .github/linters/lychee.toml README.md "docs/**/*.md" "docs/**/*.rst" "docs/**/*.ipynb"
|
||||
args: --config .github/linters/lychee.toml README.md
|
||||
|
||||
# docs_new/ (Mintlify) internal-link check. Runs only in CI — contributors
|
||||
# are NOT required to install `mint` for local pre-commit. External links
|
||||
# are covered separately by the nightly lychee job (no --check-external here).
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "20"
|
||||
|
||||
# Hard gate: docs_new internal links/anchors/redirects must resolve.
|
||||
# mint is pinned for reproducibility (its heading-slug rules are
|
||||
# version-sensitive); bump deliberately after re-verifying locally.
|
||||
- name: Check docs_new links (Mintlify broken-links)
|
||||
run: |
|
||||
npm install -g mint@4.2.559
|
||||
cd docs_new
|
||||
mint broken-links --check-anchors --check-redirects
|
||||
|
||||
- name: Run sgl-kernel clang-format checks
|
||||
uses: DoozyX/clang-format-lint-action@v0.20
|
||||
|
||||
@@ -25,8 +25,5 @@ jobs:
|
||||
args: >-
|
||||
--config .github/linters/lychee-ci.toml
|
||||
README.md
|
||||
docs/**/*.md
|
||||
docs/**/*.rst
|
||||
docs/**/*.ipynb
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
@@ -112,14 +112,14 @@ jobs:
|
||||
VERSION=$(echo "$BRANCH_NAME" | sed 's/release\///')
|
||||
|
||||
# Update git clone version references in docs
|
||||
sed -i "s/git clone -b v[0-9]\+\.[0-9]\+\.[0-9]\+\.\?post\?[0-9]*/git clone -b $VERSION/" docs/get_started/install.md
|
||||
sed -i "s/git clone -b v[0-9]\+\.[0-9]\+\.[0-9]\+\.\?post\?[0-9]*/git clone -b $VERSION/" docs/platforms/amd_gpu.md
|
||||
sed -i "s/git clone -b v[0-9]\+\.[0-9]\+\.[0-9]\+\.\?post\?[0-9]*/git clone -b $VERSION/" docs_new/docs/get-started/install.mdx
|
||||
sed -i "s/git clone -b v[0-9]\+\.[0-9]\+\.[0-9]\+\.\?post\?[0-9]*/git clone -b $VERSION/" docs_new/docs/hardware-platforms/amd_gpu.mdx
|
||||
|
||||
# Check if any changes were made
|
||||
if git diff --quiet; then
|
||||
echo "No version references needed updating"
|
||||
else
|
||||
git add docs/get_started/install.md docs/platforms/amd_gpu.md
|
||||
git add docs_new/docs/get-started/install.mdx docs_new/docs/hardware-platforms/amd_gpu.mdx
|
||||
git commit -m "docs: update version references to $VERSION"
|
||||
echo "Updated version references to $VERSION"
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user