DOS2326

Pipelines - Variable group should have a description

DOS2326

AzureDevOps project low builtIn

Description

Make sure to add a description to your pipeline variable group. This description will help define its purpose and provide clarity to users about the role of the variable group. Learn more: https://learn.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?tabs=classic

Recommendation

1. Navigate to Project -> Pipelines -> Library 
2. Select a variable group. 
3. Enter a Description. 
4. Click on 'Save'.

Policy Rule

{
  "target": "ADOProjectVariableGroup",
  "if": {
    "allOf": [
      {
        "resource": "ADOProjectVariableGroup",
        "property": "Description",
        "operator": "notEquals",
        "value": ""
      }
    ]
  },
  "then": {
    "effect": "Audit"
  }
}
« DOS2325 DOS2327 »
Rule Details
  • Rule ID: DOS2326
  • Code: ADO_Project_Pipelines_Library_VariableGroup_Should_Have_Description
  • Platform: AzureDevOps
  • Category: project
  • Severity: low
  • Type: builtIn
Related Rules

Copyright © DevOps Shield. All Rights Reserved. Privacy Policy | Cookie Policy | Terms and Conditions