Release Work Items Lister
Overview
The Release Work Items Lister extension provides a pipeline task that lists all work items associated with your Azure DevOps releases. This task can be added to your release pipeline to automatically generate a list of work items included in each deployment, helping teams maintain visibility into what features, user stories, and bug fixes are being released.
Features
- Pipeline Task Integration: Add the task to any stage of your release pipeline
- Comprehensive Work Item Listing: Automatically retrieves all work items associated with the release including:
- Work item ID and title
- Work item type (User Story, Bug, Task, etc.)
- Current state and assigned user
- Tags and other metadata
- Flexible Output Formats: Supports multiple output formats including:
- Console output for pipeline logs
- JSON format for further processing
- Markdown format for documentation
- Filtering Options: Filter work items by type, state, or other criteria
- Pipeline Variables: Outputs work item information as pipeline variables for use in subsequent tasks
Getting Started
- Install the extension from the Azure DevOps marketplace
- Add the "List Release Work Items" task to your release pipeline
- Configure the task parameters as needed
- Run your release pipeline to see work items listed in the logs
Usage
Adding the Task to Your Pipeline
- Edit your release pipeline
- Add the "List Release Work Items" task to any stage
- Configure the task settings:
- Output Format: Choose console, JSON, or markdown
- Work Item Types: Filter by specific work item types (optional)
- Work Item States: Filter by specific states (optional)
- Output File: Specify a file to save the output (optional)
Task Parameters
| Parameter |
Description |
Required |
Default |
| Output Format |
Format for the work items output (console, json, markdown) |
No |
console |
| Work Item Types |
Comma-separated list of work item types to include |
No |
All types |
| Work Item States |
Comma-separated list of work item states to include |
No |
All states |
| Output File |
Path to save the output file |
No |
None |
| Include Details |
Include detailed work item information |
No |
true |
Example Output
The task will output work items in the selected format:
Console Output:
Found 5 work items associated with this release:
- User Story #1234: Implement user authentication
- Bug #1235: Fix login page styling
- Task #1236: Update API documentation
JSON Output:
{
"workItems": [
{
"id": 1234,
"title": "Implement user authentication",
"type": "User Story",
"state": "Done",
"assignedTo": "john.doe@company.com"
}
]
}
Requirements
- Azure DevOps Services or Azure DevOps Server 2019 Update 1 or later
- Release pipeline with appropriate permissions to access work items
- The task must be run in the context of a release (not a build)
Support
For issues, feature requests, or questions, please visit our GitHub repository.
Privacy & Security
This extension only accesses work items and release data that you already have permission to view. No data is stored or transmitted outside of your Azure DevOps organization. All work item data is processed within your Azure DevOps environment.
