mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
feat: adopt directory-based docs versioning with Edge channel
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
114
.github/workflows/docs-snapshots.yml
vendored
Normal file
114
.github/workflows/docs-snapshots.yml
vendored
Normal file
@@ -0,0 +1,114 @@
|
||||
name: Docs Snapshots Guard
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- "docs/**"
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
|
||||
jobs:
|
||||
guard:
|
||||
name: Protect frozen snapshots and append-only assets
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Determine merge base
|
||||
id: base
|
||||
run: |
|
||||
base_sha="$(git merge-base "origin/${{ github.event.pull_request.base.ref }}" HEAD)"
|
||||
echo "sha=$base_sha" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Detect escape-hatch label
|
||||
id: escape
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||
run: |
|
||||
# The [docs-freeze] marker (in the PR title) is the only way to
|
||||
# legitimately modify frozen snapshots or remove published assets.
|
||||
# Detect it from the title since the workflow runs on
|
||||
# pull_request (not pull_request_target) and can't always read
|
||||
# labels reliably.
|
||||
if [[ "$PR_TITLE" == *"[docs-freeze]"* ]]; then
|
||||
echo "allowed=true" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "allowed=false" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Guard frozen snapshots
|
||||
env:
|
||||
ALLOWED: ${{ steps.escape.outputs.allowed }}
|
||||
BASE_SHA: ${{ steps.base.outputs.sha }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Anything under docs/v<X.Y.Z>/ is a frozen release snapshot and
|
||||
# must not change after the release-cut PR that introduced it.
|
||||
# The release-cut PR uses the [docs-freeze] title prefix to opt
|
||||
# out of this guard. ``docs/v[0-9]*/**`` is the defensive form so
|
||||
# we never catch a hypothetical ``docs/vendor/`` etc.
|
||||
violations="$(git diff --name-only --diff-filter=AMDRT \
|
||||
"$BASE_SHA"..HEAD -- 'docs/v[0-9]*/**' || true)"
|
||||
|
||||
if [[ -z "$violations" ]]; then
|
||||
echo "OK: no changes under docs/v*/"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [[ "$ALLOWED" == "true" ]]; then
|
||||
echo "OK: [docs-freeze] PR is allowed to touch docs/v*/:"
|
||||
echo "$violations"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "::error::This PR modifies frozen release snapshots under docs/v*/."
|
||||
echo "Frozen snapshots are immutable. To intentionally edit a snapshot"
|
||||
echo "(e.g. a release-cut PR generated by 'devtools release' or the"
|
||||
echo "manual 'scripts/docs/freeze_current_edge.py' wrapper), prefix"
|
||||
echo "the PR title with [docs-freeze]."
|
||||
echo
|
||||
echo "Offending files:"
|
||||
echo "$violations"
|
||||
exit 1
|
||||
|
||||
- name: Guard append-only images
|
||||
env:
|
||||
ALLOWED: ${{ steps.escape.outputs.allowed }}
|
||||
BASE_SHA: ${{ steps.base.outputs.sha }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Deleting or renaming an image breaks every frozen snapshot that
|
||||
# still references it (snapshots reuse docs/images/ at the docs
|
||||
# root). Only [docs-freeze] PRs are allowed to do that.
|
||||
deletions="$(git diff --name-only --diff-filter=DR \
|
||||
"$BASE_SHA"..HEAD -- 'docs/images/**' || true)"
|
||||
|
||||
if [[ -z "$deletions" ]]; then
|
||||
echo "OK: no images deleted or renamed."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [[ "$ALLOWED" == "true" ]]; then
|
||||
echo "OK: [docs-freeze] PR is allowed to delete/rename images:"
|
||||
echo "$deletions"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "::error::This PR deletes or renames files under docs/images/."
|
||||
echo "Images are append-only because frozen snapshots in docs/v*/"
|
||||
echo "share a single docs/images/ directory and would break if an"
|
||||
echo "asset they reference disappears or moves."
|
||||
echo
|
||||
echo "If the asset is wrong, add a new file with a new name and"
|
||||
echo "reference the new name in Edge (docs/edge/<lang>/...). Leave"
|
||||
echo "the old file in place so historical snapshots keep rendering."
|
||||
echo
|
||||
echo "Offending files:"
|
||||
echo "$deletions"
|
||||
exit 1
|
||||
Reference in New Issue
Block a user