Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct docs for 3 Predefined Pipeline Variable's template availability #14185

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/pipelines/build/includes/variables-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ When you use a variable in a template that is not marked as available in templat
| Build.Reason | The event that caused the build to run.<br><ul><li>`Manual`: A user manually queued the build.</li><li>`IndividualCI`: **Continuous integration (CI)** triggered by a Git push or a TFVC check-in.</li><li>`BatchedCI`: **Continuous integration (CI)** triggered by a Git push or a TFVC check-in, and the **Batch changes** was selected.</li><li>`Schedule`: **Scheduled** trigger.</li><li>`ValidateShelveset`: A user manually queued the build of a specific TFVC shelveset.</li><li>`CheckInShelveset`: **Gated check-in** trigger.</li><li>`PullRequest`: The build was triggered by a Git branch policy that requires a build.</i><li>`BuildCompletion`: The build was [triggered by another build](../../process/pipeline-triggers.md)</li><li>`ResourceTrigger`: The build was [triggered by a resource trigger](../../process/resources.md) or it was [triggered by another build](../../process/pipeline-triggers.md).</li></ul>See [Build pipeline triggers](../triggers.md), [Improve code quality with branch policies](../../../repos/git/branch-policies.md). | Yes |
| Build.Repository.Clean | The value you&#39;ve selected for **Clean** in the [source repository settings](../../repos/index.md).<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.LocalPath | The local path on the agent where your source code files are downloaded. For example: `c:\agent_work\1\s`.<br><br>By default, new build pipelines update only the changed files. You can modify how files are downloaded on the [Repository tab](../../repos/index.md).<br><br>Important note: If you check out only one Git repository, this path is the exact path to the code.<br><br>If you check out multiple repositories, the behavior is as follows (and might differ from the value of the Build.SourcesDirectory variable):<br><ul><li>If the checkout step for the self (primary) repository has no custom checkout path defined, or the checkout path is the multi-checkout default path `$(Pipeline.Workspace)/s/&<RepoName>` for the self repository, the value of this variable reverts to its default value, which is `$(Pipeline.Workspace)/s`.</li><li>If the checkout step for the self (primary) repository does have a custom checkout path defined (and it's not its multi-checkout default path), this variable contains the exact path to the self repository.</li></ul>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.ID | The unique identifier of the [repository](../../repos/index.md).<br><br>This won't change, even if the name of the repository does.<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.Name | The name of the triggering [repository](../../repos/index.md).<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.ID | The unique identifier of the [repository](../../repos/index.md).<br><br>This won't change, even if the name of the repository does.<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | Yes |
| Build.Repository.Name | The name of the triggering [repository](../../repos/index.md).<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | Yes |
| Build.Repository.Provider | The type of the triggering [repository](../../repos/index.md).<br><ul><li>`TfsGit`: [TFS Git repository](../../../repos/git/index.yml)<li>`TfsVersionControl`: [Team Foundation Version Control](../../../repos/tfvc/what-is-tfvc.md)<li>`Git`: Git repository hosted on an external server<li>`GitHub`<li>`Svn`: Subversion</ul>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.Tfvc.Workspace | Defined if your [repository](../../repos/index.md) is Team Foundation Version Control. The name of the [TFVC workspace](../../../repos/tfvc/create-work-workspaces.md) used by the build agent.<br><br>For example, if the Agent.BuildDirectory is `c:\agent_work\12` and the Agent.Id is `8`, the workspace name could be: `ws_12_8`<br><br>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.Uri | The URL for the triggering repository. For example:<br><ul><li>Git: [https://[email protected]/fabrikamfiber/_git/Scripts](https://[email protected]/fabrikamfiber/_git/Scripts)<li>TFVC: [https://dev.azure.com/fabrikamfiber/](https://dev.azure.com/fabrikamfiber/)</ul>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | No |
| Build.Repository.Uri | The URL for the triggering repository. For example:<br><ul><li>Git: [https://[email protected]/fabrikamfiber/_git/Scripts](https://[email protected]/fabrikamfiber/_git/Scripts)<li>TFVC: [https://dev.azure.com/fabrikamfiber/](https://dev.azure.com/fabrikamfiber/)</ul>This variable is agent-scoped, and can be used as an environment variable in a script and as a parameter in a build task, but not as part of the build number or as a version control tag. | Yes |
| Build.RequestedFor | See &quot;[How are the identity variables set?](#identity_values)&quot;.<br><br>Note: This value can contain whitespace or other invalid label characters. In these cases, the [label format](../../../repos/tfvc/labels-command.md) fails. | Yes |
| Build.RequestedForEmail | See &quot;[How are the identity variables set?](#identity_values)&quot;. | Yes |
| Build.RequestedForId | See &quot;[How are the identity variables set?](#identity_values)&quot;. | Yes |
Expand Down