The ** CD Release Dashboard Plugin** is a custom widget for Azure DevOps dashboards designed to display deployment pipeline statistics, including the total number of deployments, failed deployments, and failure rates for CD release pipelines. This widget allows you to track the performance and reliability of your Continuous Deployment (CD) pipelines and helps identify potential issues that may be affecting the deployment process.
Key Features
Deployment Statistics: View the total number of deployments and the number of failed deployments for each pipeline.
Failure Rate Calculation: Calculate the failure rate for each pipeline based on the number of failed deployments compared to the total number of deployments.
Dynamic Table: The widget displays a dynamic table listing modules, submodules, and pipelines along with their deployment statistics and failure rates.
Search Functionality: The table includes a search feature to quickly find specific pipelines by module or pipeline name.
Real-Time Data: The plugin fetches data from Azure DevOps using VSS API and updates the table in real-time.
Technical Details
VSS (Visual Studio Services): The plugin leverages the VSS API to fetch data from Azure DevOps, ensuring smooth integration with the Azure DevOps environment.
Modules Used:
TFS/Dashboards/WidgetHelpers: Helps in including widget styles and managing widget life cycle.
TFS/ReleaseManagement/CoreRestClient: Used to fetch deployment data for pipelines in the project.
Data Display: The data is displayed in a table format, which includes the following columns:
Module: The module of the pipeline.
Submodule: The submodule under the pipeline.
Pipeline: The name of the deployment pipeline.
Total Deployments: The total number of deployments executed for that pipeline.
Failed Deployments: The number of deployments that failed.
Failure Rate (%): Calculated as (Failed Deployments ÷ Total Deployments) × 100.
Installation
1. Clone or Download the Plugin Files
Clone or download the repository containing the plugin files.
2. Upload the Widget to Azure DevOps
Go to your Azure DevOps project and navigate to Dashboards.
Create a new dashboard or edit an existing one.
Use the Add Widget option to upload the ** CD Release Dashboard Plugin**.
Follow the prompts to configure the widget.
3. Configure the Widget
Once added to the dashboard, configure the widget by providing any necessary settings like project name, organization name, etc.
4. Start Tracking Pipelines
The widget will now start fetching deployment data from Azure DevOps and displaying the deployment statistics for each pipeline under the project.
Usage
Once the widget is installed and added to a dashboard, it will automatically fetch deployment data from the Azure DevOps environment and display it in a table format. Users can:
View deployment statistics like the number of total and failed deployments.
Track failure rates to identify pipelines with reliability issues.
Use the search functionality to quickly find specific pipelines by their name.
Limitations
This plugin fetches data based on the pipeline deployment history available in Azure DevOps.
The accuracy of the failure rate depends on the available deployment data in the system.
Contributing
Contributions are welcome! If you'd like to contribute to the development of this plugin, feel free to fork the repository and create a pull request with your changes. Make sure to follow the contribution guidelines outlined in the repository.
