X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=jjb%2Flf-macros.yaml;h=ba419c691df142406f4794b1ab0200d5e334a8d8;hb=961ef4327102f60f1d81e91b73027f032e144d6e;hp=ef5cbd76534637d8a48b3d39374a86defd4296ae;hpb=dc914933d50cbc1da5602c6975635a6ce5cf4270;p=releng%2Fglobal-jjb.git diff --git a/jjb/lf-macros.yaml b/jjb/lf-macros.yaml index ef5cbd76..ba419c69 100644 --- a/jjb/lf-macros.yaml +++ b/jjb/lf-macros.yaml @@ -289,9 +289,8 @@ name: PROJECT default: '{project}' description: | - Parameter to identify a Gerrit project. This is typically the - project repo path as exists in Gerrit. - For example: ofextensions/circuitsw + Parameter to identify a SCM project to build. This is typically + the project repo path. For example: ofextensions/circuitsw - string: name: STREAM default: '{stream}' @@ -303,28 +302,40 @@ name: GERRIT_PROJECT default: '{project}' description: | - Parameter to identify Gerrit project. This is typically the - project repo path as exists in Gerrit. - For example: ofextensions/circuitsw + Gerrit Trigger provided parameter to identify Gerrit project that + triggered the build. This is typically the project repo path as + exists in Gerrit. For example: ofextensions/circuitsw - Note that Gerrit will override this parameter automatically if a - job is triggered by Gerrit. + If using Gerrit, in a manual build this should match the PROJECT + parameter above. - string: name: GERRIT_BRANCH default: '{branch}' description: | - Parameter to identify a Gerrit branch. + Gerrit Trigger provided parameter to identify a Gerrit branch. - Note that Gerrit will override this parameter automatically if a - job is triggered by Gerrit. + If using Gerrit, in a manual build override with the branch to + build against. - string: name: GERRIT_REFSPEC default: 'refs/heads/{branch}' description: | - Parameter to identify a refspec when pulling from Gerrit. + Gerrit Trigger provided parameter to identify a refspec to fetch + from Gerrit. - Note that Gerrit will override this parameter automatically if a - job is triggered by Gerrit. + If using Gerrit, in a manual build override with a refspec. + https://git-scm.com/book/en/v2/Git-Internals-The-Refspec + For example: 'refs/heads/master' + - string: + name: sha1 + default: 'origin/{branch}' + description: | + GitHub PR Trigger provided parameter for specifying the commit + to checkout. + + If using GitHub, in a manual build override with a branch path or + sha1 hash to a specific commit. For example: 'origin/master' + # Tools - string: name: LFTOOLS_VERSION default: '{lftools-version}'