Harnessing the Power of 'az repos' Command in Azure DevOps (with examples)

The az repos command is an integral part of the Azure CLI designed to manage Azure DevOps repositories effectively. Azure CLI, also known as az, provides a set of commands for interacting with Azure services, and the az repos command specifically focuses on repository management tasks within Azure DevOps. This command-line utility streamlines the process of managing repositories, enforcing policies, and handling pull requests, making it indispensable for developers and DevOps engineers working with Azure DevOps.

Use case 1: Listing all Repos in a Specific Project

Code:

az repos list --project project_name

Motivation:

Listing all repositories within a specific project is a fundamental task for developers and project managers who need to get an overview of the repositories available in a given project. This information is crucial for managing codebases, understanding project scope, and ensuring all team members have access to the necessary repositories.

Explanation:

• az repos list: This part of the command indicates that we want to list repositories.
• --project project_name: The --project flag specifies the project within which the repositories are located. By providing a project_name, the command fetches all repos related to that particular project.

Example Output:

[
  {
    "id": "1",
    "name": "Repo1",
    "url": "https://dev.azure.com/organization/project/_git/Repo1",
    ...
  },
  {
    "id": "2",
    "name": "Repo2",
    "url": "https://dev.azure.com/organization/project/_git/Repo2",
    ...
  }
]

Use case 2: Adding Policy on a Specific Branch to Restrict Basic Merge

Code:

az repos policy merge-strategy create --repository-id repository_id_in_repos_list --branch branch_name --blocking --enabled --allow-no-fast-forward false --allow-rebase true --allow-rebase-merge true --allow-squash true

Motivation:

Implementing merge policies on a branch ensures that the codebase maintains a certain level of quality and stability. This particular policy restricts basic merges and enforces a more structured merge strategy, which is crucial for teams working on features simultaneously, preventing unwanted changes and maintaining a clean commit history.

Explanation:

• az repos policy merge-strategy create: This portion indicates the creation of a new merge policy strategy.
• --repository-id repository_id_in_repos_list: Identifies the specific repository by its unique ID.
• --branch branch_name: Specifies the branch on which the merge policy is applied.
• --blocking: Ensures the policy must be satisfied before the merge can occur.
• --enabled: Activates the policy upon creation.
• --allow-no-fast-forward false: Disallows the simplest form of merging to ensure all merges result in a commit.
• --allow-rebase true: Allows rebasing of commits as part of the merge strategy.
• --allow-rebase-merge true: Permits merging with rebased commits.
• --allow-squash true: Enables squashing of commits to form a single commit.

Example Output:

{
  "result": "Policy created and enforced on branch branch_name"
}

Use case 3: Adding Build Validation on a Specific Repository

Code:

az repos policy build create --repository-id repository_id --build-definition-id build_pipeline_id --branch main --blocking --enabled --queue-on-source-update-only true --display-name name --valid-duration minutes

Motivation:

Adding build validation as a policy on a repository helps ensure that code changes do not break the build or introduce defects. Automatic build validation provides developers with immediate feedback on code health, increasing the reliability and quality of the software being developed.

Explanation:

• az repos policy build create: Initiates creation of a build validation policy.
• --repository-id repository_id: Specifies the repository where the policy is to be applied.
• --build-definition-id build_pipeline_id: Refers to the ID of the pre-existing build pipeline used for the validation.
• --branch main: Denotes the branch to which this policy relates, typically the main development branch.
• --blocking: This ensures code changes are not merged without successful validation.
• --enabled: Activates the policy instantly.
• --queue-on-source-update-only true: The build validates only when source changes occur.
• --display-name name: Provides a user-friendly name for the policy for easy identification.
• --valid-duration minutes: Sets a time limit for how long the policy remains valid.

Example Output:

{
  "result": "Build validation policy set for repository_id on branch main"
}

Use case 4: Listing All Active Pull Requests in a Specific Repository

Code:

az repos pr list --project project_name --repository repository_name --status active

Motivation:

Monitoring active pull requests is crucial for developers and team leads to track ongoing code reviews, development progress, and collaboration within a project. This helps ensure timely code reviews and facilitates seamless integration of feature branches into the main codebase.

Explanation:

• az repos pr list: Indicates the command to list pull requests.
• --project project_name: Specifies the project under which the repository is located.
• --repository repository_name: Identifies the specific repository whose pull requests are being listed.
• --status active: Filters the pull requests to only show those that are currently active and under review.

Example Output:

[
  {
    "id": 123,
    "title": "Feature Addition",
    "createdBy": "developer1",
    "status": "active",
    ...
  },
  {
    "id": 124,
    "title": "Bug Fix",
    "createdBy": "developer2",
    "status": "active",
    ...
  }
]

Conclusion

The az repos command in Azure CLI is a versatile tool that simplifies managing Azure DevOps repositories. From listing repositories, enforcing merge policies, setting up build validations, to tracking active pull requests, this command streamlines workflows and enhances collaboration within development teams. By leveraging its capabilities, teams can ensure higher code quality, efficient project management, and seamless integration processes.