From: Jeremy Phelps Date: Mon, 15 Oct 2018 23:52:01 +0000 (-0500) Subject: Clarify git-url and git-clone-url X-Git-Tag: v0.26.0~5 X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F88%2F12988%2F3;p=releng%2Fglobal-jjb.git Clarify git-url and git-clone-url Issue-ID: RELENG-446 Change-Id: Iac125015c0ed9b7e22feef604a14b21dd5d607d3 Signed-off-by: Jeremy Phelps --- diff --git a/docs/configuration.rst b/docs/configuration.rst index 221217d1..97e9d5b6 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -36,11 +36,14 @@ values used by global-jjb templates. :git-url: Set this to the base URL of your GitHub repo. In general this should be https://github.com. If you are using GitHub Enterprise, or some other GitHub-style system, then it - should be whatever your installation base URL is. + should be whatever your installation base URL is. This sets a job + property that GitHub Pull Request Builder requires to work. + Note that this is the web url to your project: (eg. https://github.com/$ORG/$PROJECT) :git-clone-url: This is the clone prefix used by GitHub jobs. - Set this to either the same thing as **git-url** or the - 'git@github.com:' including the trailing ':' + Set this to either the same base url as **git-url**, or to + 'git@github.com:' including the trailing ':'. Determined + by your clone method (https or git). :github-org: The name of the GitHub organization interpolated into the scm config.