mirror of https://github.com/crewAIInc/crewAI.git synced 2026-07-01 05:08:12 +00:00

Files

Lucas Gomide 2b87098279 fix: cut docs version nav from Edge so new pages aren't dropped (#6349 )

* fix: freeze docs version nav from Edge instead of previous release

The docs cut copied every Edge file into the new `docs/v<X.Y.Z>/`
snapshot but built that version's `docs.json` navigation by cloning the
previous frozen release and only rewriting path prefixes. Pages added to
Edge since the last release were therefore copied to disk yet never
linked in the version selector, which is why the v1.15.0 cut shipped
without the Datadog guide. `_build_new_entry` now clones the Edge nav
entry and rewrites `edge/<locale>/` to `v<new>/<locale>/`, so promoting
Edge to Latest carries every current page and nav restructuring.

* docs: link the v1.15.0 Datadog guide dropped during the cut

The v1.15.0 freeze copied `enterprise/guides/datadog` into the snapshot
for every locale but never linked it in `docs.json`, because the cut
cloned the v1.14.7 nav instead of Edge. This backfills the missing nav
reference in the `en`, `pt-BR`, `ko`, and `ar` v1.15.0 blocks so the
already-shipped page is reachable from the version selector. Pairs with
the `_build_new_entry` fix that prevents future cuts from dropping pages.

* docs: link the v1.15.1 Datadog guide dropped during the cut

The v1.15.1 cut ran before the freeze-from-Edge fix landed, so it
inherited the same bug as v1.15.0: `enterprise/guides/datadog` was
copied into the snapshot for every locale but never linked in
`docs.json`. This backfills the missing nav reference in the `en`,
`pt-BR`, `ko`, and `ar` v1.15.1 blocks so the page is reachable from the
version selector.

2026-06-29 10:03:26 -04:00

src/crewai_devtools

fix: cut docs version nav from Edge so new pages aren't dropped (#6349 )

2026-06-29 10:03:26 -04:00

tests

fix: cut docs version nav from Edge so new pages aren't dropped (#6349 )

2026-06-29 10:03:26 -04:00

pyproject.toml

chore: widen click dependency constraint to allow 8.2+

2026-06-02 00:06:25 -07:00

README.md

feat: adopt directory-based docs versioning with Edge channel (#6202 )

2026-06-17 11:56:59 -04:00

README.md

crewai-devtools

CLI for versioning and releasing crewAI packages.

Setup

Installed automatically via the workspace (uv sync). Requires:

GitHub CLI (gh) — authenticated
OPENAI_API_KEY env var — for release note generation and translation
ENTERPRISE_REPO env var — GitHub repo for enterprise releases
ENTERPRISE_VERSION_DIRS env var — comma-separated directories to bump in the enterprise repo
ENTERPRISE_CREWAI_DEP_PATH env var — path to the pyproject.toml with the crewai[tools] pin in the enterprise repo
ENTERPRISE_WORKFLOW_PATHS env var — comma-separated workflow file paths in the enterprise repo whose crewai[extras]==<version> pins should be rewritten on each release (e.g. .github/workflows/tests.yml)
ENTERPRISE_EXTRA_PACKAGES env var — comma-separated packages to also pin in enterprise pyproject files, in addition to crewai / crewai[extras]

Commands

`devtools release <version>`

Full end-to-end release. Bumps versions, creates PRs, tags, publishes a GitHub release, and releases the enterprise repo.

devtools release 1.10.3
devtools release 1.10.3a1                # pre-release
devtools release 1.10.3 --no-edit        # skip editing release notes
devtools release 1.10.3 --dry-run        # preview without changes
devtools release 1.10.3 --skip-enterprise  # skip enterprise release phase

Flow:

Bumps __version__ and dependency pins across all lib/ packages
Runs uv sync
Creates version bump PR against main, polls until merged
Generates release notes (OpenAI) from commits since last release
Updates Edge changelogs (docs/edge/{en,pt-BR,ko,ar}/changelog.mdx)
Freezes docs/edge/ into docs/v<version>/, registers the version in docs.json, and points the canonical /<lang>/:slug* redirects at the new default
Opens a [docs-freeze] PR against main, polls until merged
Tags main and creates GitHub release
Triggers PyPI publish workflow
Clones enterprise repo, bumps versions and crewai[tools] dep, runs uv sync
Creates enterprise bump PR, polls until merged
Tags and creates GitHub release on enterprise repo

The docs-snapshots CI guard rejects writes under docs/v*/ and deletions/renames in docs/images/ unless the PR title starts with [docs-freeze]. The release CLI sets that prefix automatically; manual edits to a frozen snapshot need the same prefix to land.

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

`devtools bump <version>`

Bump versions only (phase 1 of release).

devtools bump 1.10.3
devtools bump 1.10.3 --no-push      # don't push or create PR
devtools bump 1.10.3 --no-commit    # only update files
devtools bump 1.10.3 --dry-run

`devtools tag`

Tag and release only (phase 2 of release). Run after the bump PR is merged.

devtools tag
devtools tag --no-edit
devtools tag --dry-run