Checkout part of a branch in Azure DevOps Pipelines (GetSources)

by

In Azure DevOps you don’t have option to get only part of the repository, but there is a workaround:
Disable the “Get sources” step and get only the source you want by manually executing the according git commands in a script.

To disable the default “Get Sources” just specify none in the checkout statement:

- checkout: none

In the pipeline add a CMD/PowerShell task to get the sources manually with one of the following 2 options:

1. Get only part of the repo with git sparse-checkout.
For example, get only the directories src_1 and src_2 within the test folder (lines starting with REM ### are just the usual batch comments):

- script: |
    REM ### this will create a 'root' directory for your repo and cd into it
    mkdir myRepo
    cd myRepo
    REM ### initialize Git in the current directory
    git init
    REM ### set Git sparsecheckout to TRUE
    git config core.sparsecheckout true
    REM ### write the directories that you want to pull to the .git/info/sparse-checkout file (without the root directory)
    REM ### you can add multiple directories with multiple lines
    echo test/src_1/ >> .git/info/sparse-checkout
    echo test/src_2/ >> .git/info/sparse-checkout
    REM ### fetch the remote repo using your access token
    git remote add -f origin https://[email protected]/repo
    REM ### pull the files from the source branch of this build, using the build-in Azure DevOps variable for the branch name
    git pull origin $(Build.SourceBranch)
  displayName: 'Get only test/src_1 & test/src_2 directories instead of entire repository'

Now in the builds task make myRepo the working directory.
Fetching the remote repo using an access token is necessary, since using checkout: none will prevent your login credentials from being used.
In the end of the pipeline you may want to add step to clean the myRepo directory.

2. Get parts of the repo with Azure DevOps Rest API (Git – Items – Get Items Batch).

More Related Contents:

  1. Triggering Azure DevOps builds based on changes to sub folders
  2. Fatal: Could not read password for ‘https://[email protected]’: terminal prompts disabled
  3. Git failed with a > fatal error. could not read Username for
  4. Visual Studio 2017 – Git failed with a fatal error
  5. Unable to authenticate with Git Bash to Visual Studio Team Services
  6. How can I push my existing Git repository to Team Foundation Service
  7. How to resolve merge conflict in pull request in VSTS?
  8. Semi linear merge
  9. What is HEAD in Git?
  10. Trying to fix line-endings with git filter-branch, but having no luck
  11. Remove tracking branches no longer on remote
  12. Recover from losing uncommitted changes by “git reset –hard”
  13. Cannot push to Heroku because key fingerprint
  14. How does ‘git merge’ work in details?
  15. How to disable osxkeychain as credential helper in git config?
  16. Using a remote repository with non-standard port
  17. How can I push a local Git branch to a remote with a different name easily?
  18. Git fast-forward VS no fast-forward merge
  19. Hg: How to do a rebase like git’s rebase
  20. Using Git how do I find changes between local and remote
  21. How to change git ssh user for a remote push temporarily?
  22. How to copy a Gitlab project to another Gitlab repository?
  23. gitolite push error -> remote: ENV GL_RC not set
  24. Unable to show a Git tree in terminal
  25. How to merge specific files from Git branches
  26. Git refuses to reset/discard files
  27. How does git track source code moved between files?
  28. Git: want to iterate through all commits on branch, and list files in each commit
  29. Restore git files deleted after git merge –abort
  30. Limiting file size in git repository

Leave a Comment