Azure DevOps Pipeline Generator

What is azure-pipelines.yml?

Azure Pipelines is a cloud service that you can use to automatically build and test your code project and make it available to other users. It works with just about any language or project type. You define your pipeline using YAML syntax in a file named azure-pipelines.yml.

Key Components

#

Triggers

Triggers determine when your pipeline should run.

Push (trigger): Runs when you push changes to specific branches.

Pull Request (pr): Runs when a pull request is opened or updated targeting specific branches.

#

Stages and Jobs

Pipelines are organized hierarchically:

Pipeline contains one or more Stages.

Stage contains one or more Jobs.

Job contains one or more Steps (tasks or scripts).

Stages are useful for modeling deployment phases (e.g., "Build", "Deploy to Staging", "Deploy to Production"). You can use dependsOn to control the execution order of stages.

#

Agent Pools (pool)

The pool specifies which agent (runner) should execute the pipeline. You can use Microsoft-hosted agents (like ubuntu-latest, windows-latest) or your own self-hosted agents.

#

Variables

Variables allow you to share values across your pipeline. You can define them directly in the YAML or link them to a Variable Group. Variable Groups are often backed by Azure Key Vault to securely manage secrets.

Best Practices

Never Hardcode Secrets: Use Variable Groups linked to Azure Key Vault and reference them in your pipeline.

Use Multi-Stage Pipelines: Instead of relying on Classic Release pipelines (GUI), use YAML multi-stage pipelines to keep both build and deployment logic as code.

Pin Task Versions: When using tasks (e.g., NodeTool@0), always specify the major version to avoid breaking changes.