mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
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>
128 lines
4.6 KiB
Plaintext
128 lines
4.6 KiB
Plaintext
---
|
|
title: Sequential Processes
|
|
description: A comprehensive guide to utilizing the sequential processes for task execution in CrewAI projects.
|
|
icon: forward
|
|
mode: "wide"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
CrewAI offers a flexible framework for executing tasks in a structured manner, supporting both sequential and hierarchical processes.
|
|
This guide outlines how to effectively implement these processes to ensure efficient task execution and project completion.
|
|
|
|
## Sequential Process Overview
|
|
|
|
The sequential process ensures tasks are executed one after the other, following a linear progression.
|
|
This approach is ideal for projects requiring tasks to be completed in a specific order.
|
|
|
|
### Key Features
|
|
|
|
- **Linear Task Flow**: Ensures orderly progression by handling tasks in a predetermined sequence.
|
|
- **Simplicity**: Best suited for projects with clear, step-by-step tasks.
|
|
- **Easy Monitoring**: Facilitates easy tracking of task completion and project progress.
|
|
|
|
## Implementing the Sequential Process
|
|
|
|
To use the sequential process, assemble your crew and define tasks in the order they need to be executed.
|
|
|
|
```python Code
|
|
from crewai import Crew, Process, Agent, Task, TaskOutput, CrewOutput
|
|
|
|
# Define your agents
|
|
researcher = Agent(
|
|
role='Researcher',
|
|
goal='Conduct foundational research',
|
|
backstory='An experienced researcher with a passion for uncovering insights'
|
|
)
|
|
analyst = Agent(
|
|
role='Data Analyst',
|
|
goal='Analyze research findings',
|
|
backstory='A meticulous analyst with a knack for uncovering patterns'
|
|
)
|
|
writer = Agent(
|
|
role='Writer',
|
|
goal='Draft the final report',
|
|
backstory='A skilled writer with a talent for crafting compelling narratives'
|
|
)
|
|
|
|
# Define your tasks
|
|
research_task = Task(
|
|
description='Gather relevant data...',
|
|
agent=researcher,
|
|
expected_output='Raw Data'
|
|
)
|
|
analysis_task = Task(
|
|
description='Analyze the data...',
|
|
agent=analyst,
|
|
expected_output='Data Insights'
|
|
)
|
|
writing_task = Task(
|
|
description='Compose the report...',
|
|
agent=writer,
|
|
expected_output='Final Report'
|
|
)
|
|
|
|
# Form the crew with a sequential process
|
|
report_crew = Crew(
|
|
agents=[researcher, analyst, writer],
|
|
tasks=[research_task, analysis_task, writing_task],
|
|
process=Process.sequential
|
|
)
|
|
|
|
# Execute the crew
|
|
result = report_crew.kickoff()
|
|
|
|
# Accessing the type-safe output
|
|
task_output: TaskOutput = result.tasks[0].output
|
|
crew_output: CrewOutput = result.output
|
|
```
|
|
|
|
### Note:
|
|
|
|
Each task in a sequential process **must** have an agent assigned. Ensure that every `Task` includes an `agent` parameter.
|
|
|
|
### Workflow in Action
|
|
|
|
1. **Initial Task**: In a sequential process, the first agent completes their task and signals completion.
|
|
2. **Subsequent Tasks**: Agents pick up their tasks based on the process type, with outcomes of preceding tasks or directives guiding their execution.
|
|
3. **Completion**: The process concludes once the final task is executed, leading to project completion.
|
|
|
|
## Advanced Features
|
|
|
|
### Task Delegation
|
|
|
|
In sequential processes, if an agent has `allow_delegation` set to `True`, they can delegate tasks to other agents in the crew.
|
|
This feature is automatically set up when there are multiple agents in the crew.
|
|
|
|
### Asynchronous Execution
|
|
|
|
Tasks can be executed asynchronously, allowing for parallel processing when appropriate.
|
|
To create an asynchronous task, set `async_execution=True` when defining the task.
|
|
|
|
### Memory and Caching
|
|
|
|
CrewAI supports both memory and caching features:
|
|
|
|
- **Memory**: Enable by setting `memory=True` when creating the Crew. This allows agents to retain information across tasks.
|
|
- **Caching**: By default, caching is enabled. Set `cache=False` to disable it.
|
|
|
|
### Callbacks
|
|
|
|
You can set callbacks at both the task and step level:
|
|
|
|
- `task_callback`: Executed after each task completion.
|
|
- `step_callback`: Executed after each step in an agent's execution.
|
|
|
|
### Usage Metrics
|
|
|
|
CrewAI tracks token usage across all tasks and agents. You can access these metrics after execution.
|
|
|
|
## Best Practices for Sequential Processes
|
|
|
|
1. **Order Matters**: Arrange tasks in a logical sequence where each task builds upon the previous one.
|
|
2. **Clear Task Descriptions**: Provide detailed descriptions for each task to guide the agents effectively.
|
|
3. **Appropriate Agent Selection**: Match agents' skills and roles to the requirements of each task.
|
|
4. **Use Context**: Leverage the context from previous tasks to inform subsequent ones.
|
|
|
|
This updated documentation ensures that details accurately reflect the latest changes in the codebase and clearly describes how to leverage new features and configurations.
|
|
The content is kept simple and direct to ensure easy understanding. |