This content originally appeared on DEV Community and was authored by Davide 'CoderDave' Benvegnù
Did you know you can specify multiple repositories in one Azure DevOps YAML Pipeline and cause it to trigger by updates to any of the repositories? Let me show you how
Video
As usual, if you are a visual learner, or simply prefer to watch and listen instead of reading, here you have the video with the whole explanation and demo, which to be fair is much more complete than this post.
Link to the video: https://youtu.be/6CXaEDEZZRM
If you rather prefer reading, well... let's just continue :)
Step 1: Basic Pipeline
Let's start from a very simple pipeline definition:
trigger:
- main
pool:
vmImage: 'ubuntu-latest'
steps:
- checkout: self
- script: dir $(Build.SourcesDirectory)
Nothing much to see here, just a pipeline that uses it's own repo and prints out the content after checkout
Step 2: Add More Repos
Let's now make it a little more interesting, adding some additional repos to it. We will use the resources section for it.
resources:
repositories:
- repository: tools
type: git
name: MyProject/tools
ref: main
In this case we are adding a repository named tools that belongs to the Azure DevOps Project MyProject and we tell Azure Pipelines to "consider" the branch main (I'll explain in a moment what I mean by that) and to use tools as reference name for it.
We can also reference a GitHub repository:
- repository: MyGitHubRepo
type: github
endpoint: MyGitHubServiceConnection
name: MyGitHubOrgOrUser/MyGitHubRepo
ref: releases/123
Pretty similar to the other example, but to connect to GitHub we had to specify the service connection name (in the endpoint parameter). Note that here the reference name is MyGitRepo
Finally, we can also add repositories in another Azure DevOps Organization, in a similar way:
- repository: MyOtherAzureReposGitRepository
endpoint: OtherOrgAzureReposGitServiceConnection
type: git
name: OtherProject/MyAzureReposGitRepo
We need to use the service connection as well, because we are going to connect to another organization. Note that in this case we haven't specified the branch (which is indeed optional).
Step 3: The Triggers
At this point we have all our repositories referenced in the workflow, but the pipeline still triggers only on the local repo:
trigger:
- main
If we want it to be triggered also from another repo, we can add a trigger section to the repository definition:
- repository: tools
type: git
name: MyProject/tools
ref: main
trigger:
- dev
- release
For example, with the above snippet our pipeline will be triggered every time a change occurs in wither the dev or the release branches of our tools repo.
What about the main branch specified above too, you ask? well, that is not for the triggers... (I know, confusing... keep reading and you'll know ;) )
At the time of writing, triggers work only for additional repositories in Azure DevOps, in the same organization where the Pipeline is defined. GitHub repos and other repos defined as resources cannot be used for triggering.
Step 4: Using The Code
We now have our pipelines that is triggered by multiple repos. It's very likely that you would want to also use the code for those additional repos, right?
- checkout: MyGitHubRepo
- checkout: tools
- checkout: MyOtherAzureReposGitRepository
Just add the checkout then. As you can see, we use the reference name we've specified in the resources section to let the checkout step know what we want it to do.
And here is finally where the branch in the ref parameter comes into play, because it is the branch that will be checked out:
| Repo | Branch Checkout |
|---|---|
| self | default branch |
| tools | main |
| MyGitRepo | releases/123 |
| MyAzureReposGitRepo | default branch |
If you don't specify a path in the checkout step, Azure Pipelines will use the name of the repository to create the folder, not the repository value which is used to reference the repository in the checkout step.
All Together
With all we have added, our pipeline will now look like this:
resources:
repositories:
- repository: tools
type: git
name: MyProject/tools
ref: main
trigger:
- main
- release
- repository: MyGitHubRepo
type: github
endpoint: MyGitHubServiceConnection
name: MyGitHubOrgOrUser/MyGitHubRepo
ref: releases/123
- repository: MyOtherAzureReposGitRepository
endpoint: OtherOrgAzureReposGitServiceConnection
type: git
name: OtherProject/MyAzureReposGitRepo
trigger:
- main
pool:
vmImage: 'ubuntu-latest'
steps:
- checkout: self
- checkout: MyGitHubRepo
- checkout: tools
- checkout: MyOtherAzureReposGitRepository
- script: dir $(Build.SourcesDirectory)
You can try it out and you'll see (thanks to the last step) that all the code from the 4 repos is there for you to be used
Conclusions
This feature is useful, for example, if you want to consume a tool or a library from a different repository and you want to run tests for your application whenever the tool or library is updated.
It is also good if you keep your YAML file in a separate repository from the application code and you want to trigger the pipeline every time an update is pushed to the application repository.
Let me know in the comment section below how you think this feature can relate to your processes.
Also, checkout this video, where I talk about how to Run a job next in Azure Pipelines
Like, share and follow me 🚀 for more content:
📽 YouTube
☕ Buy me a coffee
💖 Patreon
📧 Newsletter
🌐 CoderDave.io Website
👕 Merch
👦🏻 Facebook page
🐱💻 GitHub
👲🏻 Twitter
👴🏻 LinkedIn
🔉 Podcast
This content originally appeared on DEV Community and was authored by Davide 'CoderDave' Benvegnù
Davide 'CoderDave' Benvegnù | Sciencx (2021-10-08T00:15:55+00:00) Multiple Repositories in a Single Azure Pipeline. Retrieved from https://www.scien.cx/2021/10/08/multiple-repositories-in-a-single-azure-pipeline/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.