Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
This is a step-by-step guide to using Azure Pipelines to build a sample application from a Git repository. This guide uses YAML pipelines configured with the YAML pipeline editor. If you'd like to use Classic pipelines instead, see Define your Classic pipeline. For guidance on using TFVC, see Build TFVC repositories.
An Azure DevOps organization. Create one for free.
If your team already has one, then make sure you're an administrator of the Azure DevOps project that you want to use.
An ability to run pipelines on Microsoft-hosted agents. To use Microsoft-hosted agents, your Azure DevOps organization must have access to Microsoft-hosted parallel jobs. You can either purchase a parallel job or you can request a free grant.
Sign in to your Azure DevOps organization and go to your project.
Go to Pipelines, and then select New pipeline or Create pipeline if creating your first pipeline.
Do the steps of the wizard by first selecting GitHub as the location of your source code.
You might be redirected to GitHub to sign in. If so, enter your GitHub credentials.
When you see the list of repositories, select your repository.
You might be redirected to GitHub to install the Azure Pipelines app. If so, select Approve & install.
Azure Pipelines will analyze your repository and recommend the ASP.NET Core pipeline template.
When your new pipeline appears, take a look at the YAML to see what it does. When you're ready, select Save and run.
You're prompted to commit a new azure-pipelines.yml file to your repository. After you're happy with the message, select Save and run again.
If you want to watch your pipeline in action, select the build job.
You just created and ran a pipeline that we automatically created for you, because your code appeared to be a good match for the ASP.NET Core template.
You now have a working YAML pipeline (azure-pipelines.yml) in your repository that's ready for you to customize!
When you're ready to make changes to your pipeline, select it in the Pipelines page, and then Edit the azure-pipelines.yml file.
Sign in to your Azure DevOps organization and go to your project.
Go to Pipelines, and then select New pipeline or Create pipeline if creating your first pipeline.
Do the steps of the wizard by first selecting GitHub as the location of your source code.
You might be redirected to GitHub to sign in. If so, enter your GitHub credentials.
When you see the list of repositories, select your repository.
You might be redirected to GitHub to install the Azure Pipelines app. If so, select Approve & install.
Azure Pipelines will analyze your repository and recommend the Python package pipeline template.
When your new pipeline appears, take a look at the YAML to see what it does. When you're ready, select Save and run.
You're prompted to commit a new azure-pipelines.yml file to your repository. After you're happy with the message, select Save and run again.
If you want to watch your pipeline in action, select the build job.
You just created and ran a pipeline that we automatically created for you, because your code appeared to be a good match for the Python package template.
You now have a working YAML pipeline (azure-pipelines.yml) in your repository that's ready for you to customize!
When you're ready to make changes to your pipeline, select it in the Pipelines page, and then Edit the azure-pipelines.yml file.
You can view and manage your pipelines by choosing Pipelines from the left-hand menu to go to the pipelines landing page.
From the pipelines landing page you can view pipelines and pipeline runs, create and import pipelines, manage security, and drill down into pipeline and run details.
Choose Recent to view recently run pipelines (the default view), or choose All to view all pipelines.
Select a pipeline to manage that pipeline and view the runs. Select the build number for the last run to view the results of that build, select the branch name to view the branch for that run, or select the context menu to run the pipeline and perform other management actions.
Select Runs to view all pipeline runs. You can optionally filter the displayed runs.
Select a pipeline run to view information about that run.
You can choose to Retain or Delete a run from the context menu. For more information on run retention, see Build and release retention policies.
View pipeline details
The details page for a pipeline allows you to view and manage that pipeline.
Choose Edit to edit your pipeline. For more information, see YAML pipeline editor. You can also edit your pipeline by modifying the azure-pipelines.yml file directly in the repository that hosts the pipeline.
View pipeline run details
From the pipeline run summary you can view the status of your run, both while it is running and when it is complete.
From the summary pane you can view job and stage details, download artifacts, and navigate to linked commits, test results, and work items.
Jobs and stages
The jobs pane displays an overview of the status of your stages and jobs. This pane may have multiple tabs depending on whether your pipeline has stages and jobs, or just jobs. In this example, the pipeline has two stages named Build and Deploy. You can drill down into the pipeline steps by choosing the job from either the Stages or Jobs pane.
Choose a job to see the steps for that job.
From the steps view, you can review the status and details of each step. From the More actions
you can toggle timestamps or view a raw log of all steps in the pipeline.
Cancel and re-run a pipeline
If the pipeline is running, you can cancel it by choosing Cancel. If the run has completed, you can re-run the pipeline by choosing Run new.
Pipeline run more actions menu
From the More actions
menu you can download logs, add tags, edit the pipeline, delete the run, and configure retention for the run.
Note
You can't delete a run if the run is retained. If you don't see Delete, choose Stop retaining run, and then delete the run. If you see both Delete and View retention releases, one or more configured retention policies still apply to your run. Choose View retention releases, delete the policies (only the policies for the selected run are removed), and then delete the run.
Add a status badge to your repository
Many developers like to show that they're keeping their code quality high by displaying a status badge in their repo.
To copy the status badge to your clipboard:
In Azure Pipelines, go to the Pipelines page to view the list of pipelines. Select the pipeline you created in the previous section.
Select
, and then select Status badge.
Select Status badge.
Copy the sample Markdown from the Sample markdown section.
Now with the badge Markdown in your clipboard, take the following steps in GitHub:
Go to the list of files and select Readme.md. Select the pencil icon to edit.
Paste the status badge Markdown at the beginning of the file.
Commit the change to the main branch.
Notice that the status badge appears in the description of your repository.
To configure anonymous access to badges for private projects:
Navigate to Project Settings in the bottom left corner of the page
Open the Settings tab under Pipelines
Toggle the Disable anonymous access to badges slider under General
Note
Even in a private project, anonymous badge access is enabled by default. With anonymous badge access enabled, users outside your organization might be able to query information such as project names, branch names, job names, and build status through the badge status API.
Because you just changed the Readme.md file in this repository, Azure Pipelines automatically builds your code, according to the configuration in the azure-pipelines.yml file at the root of your repository. Back in Azure Pipelines, observe that a new run appears. Each time you make an edit, Azure Pipelines starts a new run.
We'll show you how to use the classic editor in Azure DevOps Server 2019 to create a build and release that prints "Hello world".
Go to Azure Repos. (The Code hub in the previous navigation)
If your project is empty, you will be greeted with a screen to help you add code to your repository. Choose the bottom choice to initialize your repo with a readme file:
Add a script to your repository
Create a PowerShell script that prints Hello world.
Go to Azure Repos.
Add a file.
In the dialog box, name your new file and create it.
HelloWorld.ps1
Copy and paste this script.
Write-Host "Hello world"
Commit (save) the file.
In this tutorial, our focus is on CI/CD, so we're keeping the code part simple. We're working in an Azure Repos Git repository directly in your web browser.
When you're ready to begin building and deploying a real app, you can use a wide range of version control clients and services with Azure Pipelines CI builds. Learn more.
Create a build pipeline
Create a build pipeline that prints "Hello world."
Select Azure Pipelines, it should automatically take you to the Builds page.
Create a new pipeline.
For new Azure DevOps users, this will automatically take you to the YAML pipeline creation experience. To get to the classic editor and complete this guide, you must turn off the preview feature for the New YAML pipeline creation experience:
Make sure that the source, project, repository, and default branch match the location in which you created the script.
Start with an Empty job.
On the left side, select Pipeline and specify whatever Name you want to use. For the Agent pool, select Hosted VS2017.
On the left side, select the plus sign ( + ) to add a task to Job 1. On the right side, select the Utility category, select the PowerShell task from the list, and then choose Add.
On the left side, select your new PowerShell script task.
For the Script Path argument, select the
button to browse your repository and select the script you created.
Select Save & queue, and then select Save.
A build pipeline is the entity through which you define your automated build pipeline. In the build pipeline, you compose a set of tasks, each of which perform a step in your build. The task catalog provides a rich set of tasks for you to get started. You can also add PowerShell or shell scripts to your build pipeline.
Publish an artifact from your build
A typical build produces an artifact that can then be deployed to various stages in a release. Here to demonstrate the capability in a simple way, we'll simply publish the script as the artifact.
On the Tasks tab, select the plus sign ( + ) to add a task to Job 1.
Select the Utility category, select the Publish Build Artifacts task, and then select Add.
Path to publish: Select the
button to browse and select the script you created.
Artifacts are the files that you want your build to produce. Artifacts can be nearly anything your team needs to test or deploy your app. For example, you've got a .DLL and .EXE executable files and .PDB symbols file of a C# or C++ .NET Windows app.
To enable you to produce artifacts, we provide tools such as copying with pattern matching, and a staging directory in which you can gather your artifacts before publishing them. See Artifacts in Azure Pipelines.
Enable continuous integration (CI)
Select the Triggers tab.
Enable Continuous integration.
A continuous integration trigger on a build pipeline indicates that the system should automatically queue a new build whenever a code change is committed. You can make the trigger more general or more specific, and also schedule your build (for example, on a nightly basis). See Build triggers.
Save and queue the build
Save and queue a build manually and test your build pipeline.
Select Save & queue, and then select Save & queue.
On the dialog box, select Save & queue once more.
This queues a new build on the Microsoft-hosted agent.
You see a link to the new build on the top of the page.
Choose the link to watch the new build as it happens. Once the agent is allocated, you'll start seeing the live logs of the build. Notice that the PowerShell script is run as part of the build, and that "Hello world" is printed to the console.
Go to the build summary. On the Artifacts tab of the build, notice that the script is published as an artifact.
Add some variables and commit a change to your script
We'll pass some build variables to the script to make our pipeline a bit more interesting. Then we'll commit a change to a script and watch the CI pipeline run automatically to validate the change.
Edit your build pipeline.
On the Tasks tab, select the PowerShell script task.
Now you can see the results of your changes. Go to Azure Pipelines and select Queued. Notice under the Queued or running section that a build is automatically triggered by the change that you committed.
Select the new build that was created and view its log.
Notice that the person who changed the code has their name printed in the greeting message. You also see printed that this was a CI build.
We just introduced the concept of build variables in these steps. We printed the value of a variable that is automatically predefined and initialized by the system. You can also define custom variables and use them either in arguments to your tasks, or as environment variables within your scripts. To learn more about variables, see Build variables.
You've got a build pipeline. What's next?
You've created a build pipeline that automatically builds and validates whatever code is checked in by your team. At this point, you can continue to the next section to learn about release pipelines. Or, if you prefer, you can skip ahead to create a build pipeline for your app.
Create a release pipeline
Define the process for running the script in two stages.
Go to the Pipelines tab, and then select Releases.
Select the action to create a New pipeline. If a release pipeline is already created, select the plus sign ( + ) and then select Create a release pipeline.
Select the action to start with an Empty job.
Name the stage QA.
In the Artifacts panel, select + Add and specify a Source (Build pipeline). Select Add.
Select the Lightning bolt to trigger continuous deployment and then enable the Continuous deployment trigger on the right.
Select the Tasks tab and select your QA stage.
Select the plus sign ( + ) for the job to add a task to the job.
On the Add tasks dialog box, select Utility, locate the PowerShell task, and then select its Add button.
On the left side, select your new PowerShell script task.
For the Script Path argument, select the
button to browse your artifacts and select the script you created.
On the Pipeline tab, select the QA stage and select Clone.
Rename the cloned stage Production.
Rename the release pipeline Hello world.
Save the release pipeline.
A release pipeline is a collection of stages to which the application build artifacts are deployed. It also defines the actual deployment pipeline for each stage, as well as how the artifacts are promoted from one stage to another.
Also, notice that we used some variables in our script arguments. In this case, we used release variables instead of the build variables we used for the build pipeline.
Deploy a release
Run the script in each stage.
Create a new release.
When Create new release appears, select Create.
Open the release that you created.
View the logs to get real-time data about the release.
You can track the progress of each release to see if it has been deployed to all the stages. You can track the commits that are part of each release, the associated work items, and the results of any test runs that you've added to the release pipeline.
Change your code and watch it automatically deploy to production
We'll make one more change to the script. This time it will automatically build and then get deployed all the way to the production stage.
Go to the Code hub, Files tab, edit the HelloWorld.ps1 file, and change it as follows:
Param(
[string]$greeter,
[string]$trigger
)
Write-Host "Hello world" from $greeter
Write-Host Trigger: $trigger
Write-Host "Now that you've got CI/CD, you can automatically deploy your app every time your team checks in code."
Commit (save) the script.
Select the Builds tab to see the build queued and run.
After the build is completed, select the Releases tab, open the new release, and then go to the Logs.
Your new code automatically is deployed in the QA stage, and then in the Production stage.
In many cases, you probably would want to edit the release pipeline so that the production deployment happens
only after some testing and approvals are in place. See Approvals and gates overview.
Next steps
You learned how to create your first pipeline in Azure. Now, Learn more about configuring pipelines in the language of your choice:
To delete a pipeline, navigate to the summary page for that pipeline, and choose Delete from the ... menu at the top-right of the page. Type the name of the pipeline to confirm, and choose Delete.
To delete a pipeline using Azure CLI, you can use the az pipeline delete command. This command requires the id of the pipeline to delete, which you can find using the az pipeline list command.
folder-path: If specified, filters to definitions under this folder.
name: Limit results to pipelines with this name or starting with this name. Examples: FabCI or Fab*.
org or organization: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
project or p: Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
query-order: Order of the results. Accepted values: ModifiedAsc, ModifiedDesc, NameAsc, NameDesc, None
repository: Limit results to pipelines associated with this repository.
repository-type: Limit results to pipelines associated with this repository type. It's mandatory to pass repository argument along with this argument. Accepted values: bitbucket, git, github, githubenterprise, svn, tfsgit, tfsversioncontrol
org or organization: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
project or p: Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.
yes or y: Don't prompt for confirmation.
Example
The following example lists pipelines in table format, and then deletes the pipeline with an ID of 6. This example uses the following default configuration: az devops configure --defaults organization=https://dev.azure.com/fabrikam-tailspin project=FabrikamFiber
az pipelines list --output table
ID Path Name Status Default Queue
---- ------ ------------- -------- ------------------
6 \ FabrikamFiber enabled Hosted Ubuntu 1604
az pipelines delete --id 6
Are you sure you want to delete this pipeline? (y/n): y
Pipeline 6 was deleted successfully.
Azure DevOps CLI commands aren't supported for Azure DevOps Server.
You've learned the basics of creating and running a pipeline.
Now you're ready to configure your build pipeline for the programming language you're using.
Go ahead and create a new build pipeline, and this time, use one of the following templates.
Git service providers such as GitHub and Bitbucket Cloud
Subversion
How do I replicate a pipeline?
If your pipeline has a pattern that you want to replicate in other pipelines, clone it, export it, or save it as a template.
After you clone a pipeline, you can make changes and then save it.
After you export a pipeline, you can import it from the All pipelines tab.
After you create a template, your team members can use it to follow the pattern in new pipelines.
Tip
If you're using the New Build Editor, then your custom templates are shown at the bottom of the list.
How do I work with drafts?
If you're editing a build pipeline and you want to test some changes that are not yet ready for production, you can save it as a draft.
You can edit and test your draft as needed.
When you're ready, you can publish the draft to merge the changes into your build pipeline.
Or, if you decide to discard the draft, you can delete it from the All Pipeline tab shown above.
How can I delete a pipeline?
To delete a pipeline, navigate to the summary page for that pipeline, and choose Delete from the ... menu in the top-right of the page. Type the name of the pipeline to confirm, and choose Delete.