From 8d16f187e6a506a1f063210e68029d2fa5a4af93 Mon Sep 17 00:00:00 2001 From: Sanskar Jaiswal Date: Mon, 24 Jul 2023 13:26:39 +0530 Subject: [PATCH] gitrepo: document limitation of `spec.ref.name` with Azure Devops Signed-off-by: Sanskar Jaiswal --- docs/spec/v1/gitrepositories.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/spec/v1/gitrepositories.md b/docs/spec/v1/gitrepositories.md index 4a2a52493..0630901ea 100644 --- a/docs/spec/v1/gitrepositories.md +++ b/docs/spec/v1/gitrepositories.md @@ -319,6 +319,12 @@ Valid examples are: `refs/heads/main`, `refs/tags/v0.1.0`, `refs/pull/420/head`, This field takes precedence over [`.branch`](#branch-example), [`.tag`](#tag-example), and [`.semver`](#semver-example). +**Note:** Azure DevOps and AWS CodeCommit do not support fetching the HEAD of +a pull request. While Azure DevOps allows you to fetch the merge commit that +will be created after merging a PR (using `refs/pull//merge`), this field +can only be used to fetch references that exist in the current state of the Git +repository and not references that will be created in the future. + #### Commit example To Git checkout a specified commit, use `.spec.ref.commit`: