Skip to content

Commit 6422669

Browse files
committed
chore: fix licensing workflow example
1 parent 74ee5f4 commit 6422669

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

src/content/docs/rover/guides/write-workflows.mdx

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,10 @@ Follow these steps to build the `licensing-expert` workflow piece by piece.
9999
that use copyleft licenses (GPL, AGPL, LGPL), have no license,
100100
or have licenses that conflict with common permissive usage.
101101
outputs:
102-
- name: license_analysis
102+
- name: analysis
103103
description: 'Detailed dependency and license analysis'
104104
type: string
105105

106-
107106
- id: report
108107
type: agent
109108
name: 'Generate Report'
@@ -118,6 +117,11 @@ Follow these steps to build the `licensing-expert` workflow piece by piece.
118117
- Table of all dependencies with their license types
119118
- List of flagged issues (copyleft, missing, or conflicting licenses)
120119
- Recommended actions to resolve each issue
120+
outputs:
121+
- name: licensing_report
122+
description: 'Markdown report of licensing issues and compliance status'
123+
type: file
124+
filename: 'licensing_report.md'
121125
```
122126
</StepItem>
123127
<StepItem step={6}>
@@ -170,7 +174,7 @@ Steps are the sequential actions the agent executes. Each step has a unique `id`
170174
The `licensing-expert` workflow uses two steps:
171175

172176
1. **Analyze Dependencies** — Scans the project and catalogues every dependency with its license type
173-
2. **Generate Report** — Takes the analysis output and writes a structured `licensing.md` file
177+
2. **Generate Report** — Takes the analysis output and writes a structured `licensing_report.md` file
174178

175179
Steps can declare their own outputs, which later steps reference through template syntax. In this workflow, the `analyze` step produces an `analysis` output that the `report` step consumes:
176180

@@ -199,15 +203,18 @@ steps:
199203
Using the analysis below, create a comprehensive licensing report.
200204
201205
Analysis:
202-
{{steps.analyze.outputs.analysis_report}}
203-
204-
Write the report to `analysis_report.md`.
206+
{{steps.analyze.outputs.analysis}}
205207
206208
The report must include:
207209
- Executive summary of licensing status
208210
- Table of all dependencies with their license types
209211
- List of flagged issues (copyleft, missing, or conflicting licenses)
210212
- Recommended actions to resolve each issue
213+
outputs:
214+
- name: licensing_report
215+
description: 'Markdown report of licensing issues and compliance status'
216+
type: file
217+
filename: 'licensing_report.md'
211218
```
212219

213220
You can override the AI tool or model for individual steps and set step-level timeouts or retries. See the [Workflow YAML File reference](/rover/reference/workflow-file#agent-step-configuration) for all step properties.
@@ -297,13 +304,18 @@ steps:
297304
Using the analysis below, create a comprehensive licensing report.
298305
299306
Analysis:
300-
{{steps.analyze.outputs.analysis_report}}
307+
{{steps.analyze.outputs.analysis}}
301308
302309
The report must include:
303310
- Executive summary of licensing status
304311
- Table of all dependencies with their license types
305312
- List of flagged issues (copyleft, missing, or conflicting licenses)
306313
- Recommended actions to resolve each issue
314+
outputs:
315+
- name: licensing_report
316+
description: 'Markdown report of licensing issues and compliance status'
317+
type: file
318+
filename: 'licensing_report.md'
307319
```
308320

309321
## Register the workflow
@@ -401,7 +413,7 @@ After the task completes, inspect the generated report.
401413
Check the generated report.
402414

403415
```Sh
404-
rover inspect --file=analysis_report.md 1
416+
rover inspect --file=licensing_report.md 1
405417
```
406418
</StepItem>
407419
<StepItem step={2}>

0 commit comments

Comments
 (0)