Skip to content

Commit 8d16f18

Browse files
committed
gitrepo: document limitation of spec.ref.name with Azure Devops
Signed-off-by: Sanskar Jaiswal <[email protected]>
1 parent 7f40be7 commit 8d16f18

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/spec/v1/gitrepositories.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,12 @@ Valid examples are: `refs/heads/main`, `refs/tags/v0.1.0`, `refs/pull/420/head`,
319319
This field takes precedence over [`.branch`](#branch-example),
320320
[`.tag`](#tag-example), and [`.semver`](#semver-example).
321321

322+
**Note:** Azure DevOps and AWS CodeCommit do not support fetching the HEAD of
323+
a pull request. While Azure DevOps allows you to fetch the merge commit that
324+
will be created after merging a PR (using `refs/pull/<id>/merge`), this field
325+
can only be used to fetch references that exist in the current state of the Git
326+
repository and not references that will be created in the future.
327+
322328
#### Commit example
323329

324330
To Git checkout a specified commit, use `.spec.ref.commit`:

0 commit comments

Comments
 (0)