mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-25 16:55:11 +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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
79 lines
2.8 KiB
Plaintext
79 lines
2.8 KiB
Plaintext
---
|
|
title: Replay Tasks from Latest Crew Kickoff
|
|
description: Replay tasks from the latest crew.kickoff(...)
|
|
icon: arrow-right
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
CrewAI provides the ability to replay from a task specified from the latest crew kickoff. This feature is particularly useful when you've finished a kickoff and may want to retry certain tasks or don't need to refetch data over and your agents already have the context saved from the kickoff execution so you just need to replay the tasks you want to.
|
|
|
|
<Note>
|
|
You must run `crew.kickoff()` before you can replay a task.
|
|
Currently, only the latest kickoff is supported, so if you use `kickoff_for_each`, it will only allow you to replay from the most recent crew run.
|
|
</Note>
|
|
|
|
Here's an example of how to replay from a task:
|
|
|
|
### Replaying from Specific Task Using the CLI
|
|
|
|
To use the replay feature, follow these steps:
|
|
|
|
<Steps>
|
|
<Step title="Open your terminal or command prompt."></Step>
|
|
<Step title="Navigate to the directory where your CrewAI project is located."></Step>
|
|
<Step title="Run the following commands:">
|
|
To view the latest kickoff task_ids use:
|
|
|
|
```shell
|
|
crewai log-tasks-outputs
|
|
```
|
|
|
|
Once you have your `task_id` to replay, use:
|
|
|
|
```shell
|
|
crewai replay -t <task_id>
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Note>
|
|
Ensure `crewai` is installed and configured correctly in your development environment.
|
|
</Note>
|
|
|
|
### Replaying from a Task Programmatically
|
|
|
|
To replay from a task programmatically, use the following steps:
|
|
|
|
<Steps>
|
|
<Step title="Specify the `task_id` and input parameters for the replay process.">
|
|
Specify the `task_id` and input parameters for the replay process.
|
|
</Step>
|
|
<Step title="Execute the replay command within a try-except block to handle potential errors.">
|
|
Execute the replay command within a try-except block to handle potential errors.
|
|
<CodeGroup>
|
|
```python Code
|
|
def replay():
|
|
"""
|
|
Replay the crew execution from a specific task.
|
|
"""
|
|
task_id = '<task_id>'
|
|
inputs = {"topic": "CrewAI Training"} # This is optional; you can pass in the inputs you want to replay; otherwise, it uses the previous kickoff's inputs.
|
|
try:
|
|
YourCrewName_Crew().crew().replay(task_id=task_id, inputs=inputs)
|
|
|
|
except subprocess.CalledProcessError as e:
|
|
raise Exception(f"An error occurred while replaying the crew: {e}")
|
|
|
|
except Exception as e:
|
|
raise Exception(f"An unexpected error occurred: {e}")
|
|
```
|
|
</CodeGroup>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Conclusion
|
|
|
|
With the above enhancements and detailed functionality, replaying specific tasks in CrewAI has been made more efficient and robust.
|
|
Ensure you follow the commands and steps precisely to make the most of these features. |