mirror of https://github.com/crewAIInc/crewAI.git synced 2026-06-30 20:58:11 +00:00

Files

Lucas Gomide 93dafe2637 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>

2026-06-17 11:08:45 -03:00

4.7 KiB

Raw Blame History

Releasing crewai

The release CLI (devtools release) drives the full end-to-end flow, including the docs-versioning step that has to happen at every release cut. This runbook is the human-facing summary; the canonical implementation lives in lib/devtools/src/crewai_devtools/cli.py.

Why a docs-versioning step exists

Until the v1.15 series, docs/docs.json had 16 "versions" in its selector but every one of them rendered the same single-source MDX files. Picking v1.10.0 in the dropdown silently served the latest docs from main. We fixed that by adopting Mintlify's directory-based versioning: each release gets its own frozen snapshot under docs/v<X.Y.Z>/, an Edge selector renders the rolling main state (docs/edge/...) for unreleased work, and the canonical /<lang>/... URLs redirect to whichever version is currently default + Latest.

The release-cut step keeps this model honest. Skip it and the new release will not appear in the selector and the canonical URLs will keep pointing at the previous default — i.e. users following a stale link land on docs that don't describe the version they just installed.

Happy path: `devtools release`

For a normal release:

devtools release 1.15.0

This runs the full pipeline:

Phase 1 — version bump PR, polls until merged.
Phase 2 — generates AI release notes, then opens the docs PR titled [docs-freeze] docs: snapshot and changelog for v1.15.0. That PR:
- prepends a release entry to docs/edge/<lang>/changelog.mdx for every supported locale,
- copies docs/edge/ into docs/v1.15.0/,
- rewrites openapi: MDX refs inside the snapshot so each frozen page reads its own OpenAPI YAML instead of the live one,
- inserts a v1.15.0 entry into every language block in docs/docs.json, marks it default: true with tag "Latest", and demotes the previous default,
- rewires the wildcard redirects so /<lang>/:slug* lands on /v1.15.0/<lang>/:slug*.
The CLI polls until you (or another reviewer) merge the docs PR.
Phase 2 (cont.) — tags main, creates the GitHub release, triggers publish.yml, and bumps the deployment_test repo.
Phase 3 — clones the enterprise repo, bumps versions, opens its bump PR, polls, then tags + releases enterprise.

The [docs-freeze] PR title prefix is what the docs-snapshots.yml CI guard reads to allow the snapshot directory and any image deletions to land. The CLI sets it automatically.

Pre-releases (e.g. 1.15.0a1) skip the snapshot step — they ride Edge — and the docs PR title omits the [docs-freeze] prefix.

Manual escape hatch: freeze script

If you ever need to freeze without going through the full release flow (e.g. retroactively snapshotting a release that shipped without docs versioning, or testing the freeze locally):

python scripts/docs/freeze_current_edge.py 1.15.0

This is a thin wrapper around the same crewai_devtools.docs_versioning.freeze function used by devtools release. It updates the snapshot + docs.json

redirects but does not touch changelogs, open a PR, or coordinate with the rest of the release flow. Pair it with a manual PR titled [docs-freeze] snapshot docs for v1.15.0.

Lifecycle reminders

Edge (docs/edge/...) always reflects main. After a release cut, fixes to the just-released docs go into Edge as normal PRs and ship with the next release.
We do not back-port docs fixes into older frozen snapshots. If a fix matters enough to publish on an older version, it is a deliberate [docs-freeze] PR — treat that as an exception.
The freeze function is idempotent. If you have to re-run it (e.g. you pushed a docs fix between snapshotting and merging the PR), delete the partially-built docs/v<X.Y.Z>/ directory first and run again.

Troubleshooting

The freeze step warned that the snapshot was already current. Either someone else already cut this version, or a previous run left a stale docs/v<X.Y.Z>/ directory. Inspect it, then either keep going or delete the directory and re-run.
CI fails on a non-[docs-freeze] PR claiming you modified frozen snapshots. Check the diff — almost always this is an accidental edit under docs/v*/. Move the change to the matching path under docs/edge/<lang>/... instead. If you truly need to edit a frozen snapshot, re-title the PR with the [docs-freeze] prefix and document the reason in the PR description.
CI fails on a non-[docs-freeze] PR claiming you deleted an image. Add a new image under a new filename and reference that from Edge. Leave the old file in place so older snapshots keep rendering.

4.7 KiB Raw Blame History