Create your first pipeline
This is a step-by-step guide to using Azure Pipelines to build a GitHub repository.
- You need an Azure DevOps organization. If you don't have one, you can 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 Azure DevOps organization is different from your GitHub organization. Give them the same name if you want alignment between them.)
- You need a GitHub account, where you can create a repository.
Get the sample code
You can use Azure Pipelines to build an app written in any language. Select a sample repository of your choice from the following languages and fork it into your own GitHub user account:
|Programming language||Repository with a sample app|
You should now have a sample app in your GitHub account.
Get your first build
Sign in to your Azure DevOps organization and navigate to your project.
In your project, navigate to the Pipelines page. Then choose New pipeline.
Walk through the steps of the wizard by first selecting GitHub as the location of your source code.
For the second step, choose to Authorize with OAuth by selecting Authorize. You might be redirected to GitHub to sign in. Enter your GitHub credentials.
When you're redirected back to Azure Pipelines, select the sample app repository.
For the third step, Azure Pipelines analyzes the code in your repository. If your repository already contains an
azure-pipelines.ymlfile, which is the case for all sample repositories, then this step is skipped. Or else, Azure Pipelines recommends a starter template based on the code in your repository.
In the final step, you're shown the YAML file that will be used.
If you see the Run, button, then choose it and skip to the next step. If you see the Save and run button, then first select Commit directly to the master branch, and then choose Save and run.
Wait for the build to finish.
Add a CI status badge to your repository
Many developers like to show that they're keeping their code quality high by displaying a CI build status badge in their repo.
To copy the status badge to your clipboard:
In Azure Pipelines, go to the Builds page to view the list of pipelines.
Select the pipeline that was created for you.
In the context menu for the pipeline, select Status badge.
Copy the sample Markdown from the status badge panel.
Now with the status badge in your clipboard, take the following steps in GitHub:
azure-pipelines.ymlfile at the root of your repository. The YAML file contains the instructions for the pipeline. The next time you change any file in this repository, Azure Pipelines will automatically build your code.
Go back to the list of files and select the
Readme.mdfile. Then choose Edit.
Paste the status badge Markdown that you copied in the previous section at the beginning of the
Commit the change to the master branch.
Notice that the status badge appears in the description of your repository.
Back in Azure Pipelines, observe that a new build is queued. Its status might be either not started or running.
You've just learned the basics of using Azure Pipelines. Now you're ready to further configure your pipeline to run tests, publish test results, create container images, or even deploy the app to a cloud service. Follow a track for the language of your choice:
To adjust the timeout of your job, see Timeouts.
To run your pipeline in a container, see Container jobs.
For details about building GitHub repositories, see Build GitHub repositories.
To learn what else you can do in YAML pipelines, see YAML schema reference.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.