-
Notifications
You must be signed in to change notification settings - Fork 18
docs: Add recent-workflow-doc-creator workflow example #3277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
awlevin
wants to merge
2
commits into
main
Choose a base branch
from
docs/example-recent-workflow-doc-creator-20251201050715
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
26
examples/workflows/recent-workflow-doc-creator/workflow.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| 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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new example workflow imports
.nodes.*and.triggers.scheduled, but therecent-workflow-doc-creatordirectory only containsREADME.mdandworkflow.py(nonodes/ortriggers/subpackages anywhere in the repo perrg/ls). Importing this workflow will immediately raiseModuleNotFoundError, 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 👍 / 👎.