From 7b962cc655faab77e5e17d229cc8c9550b447f5a Mon Sep 17 00:00:00 2001 From: Jeremy Phelps Date: Mon, 15 Oct 2018 18:52:01 -0500 Subject: [PATCH] Clarify git-url and git-clone-url Issue-ID: RELENG-446 Change-Id: Iac125015c0ed9b7e22feef604a14b21dd5d607d3 Signed-off-by: Jeremy Phelps --- docs/configuration.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) 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. -- 2.16.6