From 2d19aabde5a0446ee34c7b6787912423915cfb79 Mon Sep 17 00:00:00 2001
From: Chris Nelson <32886763+CN120@users.noreply.github.com>
Date: Mon, 2 Dec 2024 14:55:18 -0800
Subject: [PATCH] update hosted vars
---
docs/pipelines/build/includes/variables-hosted.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/pipelines/build/includes/variables-hosted.md b/docs/pipelines/build/includes/variables-hosted.md
index 84553db01b5..996eca19152 100644
--- a/docs/pipelines/build/includes/variables-hosted.md
+++ b/docs/pipelines/build/includes/variables-hosted.md
@@ -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.
- `Manual`: A user manually queued the build.
- `IndividualCI`: **Continuous integration (CI)** triggered by a Git push or a TFVC check-in.
- `BatchedCI`: **Continuous integration (CI)** triggered by a Git push or a TFVC check-in, and the **Batch changes** was selected.
- `Schedule`: **Scheduled** trigger.
- `ValidateShelveset`: A user manually queued the build of a specific TFVC shelveset.
- `CheckInShelveset`: **Gated check-in** trigger.
- `PullRequest`: The build was triggered by a Git branch policy that requires a build.
- `BuildCompletion`: The build was [triggered by another build](../../process/pipeline-triggers.md)
- `ResourceTrigger`: The build was [triggered by a resource trigger](../../process/resources.md) or it was [triggered by another build](../../process/pipeline-triggers.md).
See [Build pipeline triggers](../triggers.md), [Improve code quality with branch policies](../../../repos/git/branch-policies.md). | Yes |
| Build.Repository.Clean | The value you've selected for **Clean** in the [source repository settings](../../repos/index.md).
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`.
By default, new build pipelines update only the changed files. You can modify how files are downloaded on the [Repository tab](../../repos/index.md).
Important note: If you check out only one Git repository, this path is the exact path to the code.
If you check out multiple repositories, the behavior is as follows (and might differ from the value of the Build.SourcesDirectory variable):
- 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/&` for the self repository, the value of this variable reverts to its default value, which is `$(Pipeline.Workspace)/s`.
- 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.
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).
This won't change, even if the name of the repository does.
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).
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).
This won't change, even if the name of the repository does.
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).
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).
- `TfsGit`: [TFS Git repository](../../../repos/git/index.yml)
- `TfsVersionControl`: [Team Foundation Version Control](../../../repos/tfvc/what-is-tfvc.md)
- `Git`: Git repository hosted on an external server
- `GitHub`
- `Svn`: Subversion
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.
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`
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:
- Git: [https://fabrikamfiber@dev.azure.com/fabrikamfiber/_git/Scripts](https://fabrikamfiber@dev.azure.com/fabrikamfiber/_git/Scripts)
- TFVC: [https://dev.azure.com/fabrikamfiber/](https://dev.azure.com/fabrikamfiber/)
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:
- Git: [https://fabrikamfiber@dev.azure.com/fabrikamfiber/_git/Scripts](https://fabrikamfiber@dev.azure.com/fabrikamfiber/_git/Scripts)
- TFVC: [https://dev.azure.com/fabrikamfiber/](https://dev.azure.com/fabrikamfiber/)
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 "[How are the identity variables set?](#identity_values)".
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 "[How are the identity variables set?](#identity_values)". | Yes |
| Build.RequestedForId | See "[How are the identity variables set?](#identity_values)". | Yes |