Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions examples/workflows/recent-workflow-doc-creator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Recent Workflow Documentation Creator

This workflow automatically creates GitHub pull requests to document recently deployed Vellum workflows.

## Description

A scheduled workflow that runs daily to:
1. Fetch all workflow deployments created in the last 24 hours
2. Process each deployment by fetching its workflow code
3. Use a GitHub agent to create pull requests with workflow examples

## Key Features

- **Scheduled Trigger**: Runs automatically at 10:00 AM Mountain Time daily
- **Map Node Pattern**: Processes multiple deployments concurrently (max concurrency of 4)
- **Tool-Calling Agent**: Uses Claude with GitHub integration tools to:
- Create new branches
- Commit workflow code and README files
- Open pull requests
- **Parallel Outputs**: Returns multiple outputs simultaneously (PR URLs, comments, deployments JSON)

## Workflow Structure

```
Scheduled Trigger → FetchRecentDeployments → ProcessDeployments (Map) → {
DeploymentsOutput,
CommentsOutput,
PrUrlsOutput
}
```

## Notable Patterns

1. **Subworkflow with Map Node**: The `ProcessDeployments` node is a Map Node that contains its own subworkflow for processing each deployment.

2. **Vellum Integration Tools**: Uses `VellumIntegrationToolDefinition` with Composio's GitHub integration for branch/file/PR operations.

3. **Custom Node Display**: Nodes use custom icons and colors for better visual organization in the UI.

4. **API Client Access**: Accesses the Vellum client via `self._context.vellum_client` for fetching deployment data.

## Use Case

This workflow is perfect for teams who want to automatically document their workflows as they're deployed, maintaining an up-to-date examples repository without manual intervention.
26 changes: 26 additions & 0 deletions examples/workflows/recent-workflow-doc-creator/workflow.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
from vellum.workflows import BaseWorkflow

from .nodes.comments_output import CommentsOutput
from .nodes.deployments_output import DeploymentsOutput
from .nodes.fetch_recent_deployments import FetchRecentDeployments
from .nodes.pr_urls_output import PrUrlsOutput
Comment on lines +3 to +6

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Provide missing node/trigger modules for workflow

The new example workflow imports .nodes.* and .triggers.scheduled, but the recent-workflow-doc-creator directory only contains README.md and workflow.py (no nodes/ or triggers/ subpackages anywhere in the repo per rg/ls). Importing this workflow will immediately raise ModuleNotFoundError, so the example cannot run or be opened in the SDK. Please add the referenced node and trigger definitions or adjust the imports.

Useful? React with 👍 / 👎.

from .nodes.process_deployments import ProcessDeployments
from .triggers.scheduled import Scheduled


class Workflow(BaseWorkflow):
graph = (
Scheduled
>> FetchRecentDeployments
>> ProcessDeployments
>> {
DeploymentsOutput,
CommentsOutput,
PrUrlsOutput,
}
)

class Outputs(BaseWorkflow.Outputs):
pr_results = PrUrlsOutput.Outputs.value
deployments_processed = CommentsOutput.Outputs.value
deployments_json = DeploymentsOutput.Outputs.value