Merge "Add an appendix to the README"

[releng/global-jjb.git] / README.md

diff --git a/README.md b/README.md
index 61b8739..63cdff3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -78,9 +78,18 @@ Trigger global configuration.
 **jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh
 connections.
 
-If you are using GitHub then there is one more parameter which
+If you are using GitHub then there are two more parameters which
 will need to be placed in the defaults.yaml
 
+**git-url**: This should be set to the base URL of your GitHub. 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.
+
+**git-clone-url**: This is the clone prefix used by GitHub jobs. This
+should be set to either the same thing as **git-url** or the
+'git@github.com:' including the trailing ':'
+
 **github-org**: The name of the GitHub organization.
 
 defaults.yaml:
@@ -187,3 +196,13 @@ in the same structure as configured in the archives directory.
 In this method a job can define a globstar for example ``**/*.log`` which then
 causes the archive script to do a globstar search for that pattern and archives
 any files it finds matching.
+
+## Appendix
+
+### ShellCheck
+
+If ShellCheck is being used to lint global-jjb or any projects that include
+global-jjb as part of their project (common with ci-management repos) then
+a minimum version of ShellCheck 0.4.x is required as the shell scripts in
+this repo uses annotations that were introduced in 0.4..
+