doc: explain GIT_REMOTE_REF in COLLABORATOR_GUIDE

PR-URL: #30371 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Nov 21, 2019 · 9940116 · 9940116
1 parent 027bde5
commit 9940116
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md
@@ -189,6 +189,12 @@ Build". It is in the left navigation of the relevant `node-test-pull-request`
 job. It will preserve all the green results from the current job but re-run
 everything else.
 
+Some of the CI Jobs may require `GIT_REMOTE_REF` which is the remote portion
+of Git refspec. To specify the branch this way `refs/heads/BRANCH` is used
+(i.e for `master` -> `refs/heads/master`).
+For pull requests it will look like `refs/pull/PR_NUMBER/head`
+(i.e. for PR#42 -> `refs/pull/42/head`).
+
 #### Useful CI Jobs
 
 * [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)