Adding a dedicated page to environment variables to make it easier fo…

…r folks to find them
groupon · Mar 7, 2016 · 7b0123b · 7b0123b
1 parent 0843c1d
commit 7b0123b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/user-guide/EnvironmentVariables.md b/docs/user-guide/EnvironmentVariables.md
@@ -0,0 +1,15 @@
+## Environment Variables
+
+In addition to [Jenkins build
+variables](https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-JenkinsSetEnvironmentVariables),
+DotCi provides the following global variables:
+
+* `DOTCI_BRANCH` -  current branch
+* `DOTCI` - always true
+* `CI` - always true
+* `DOTCI_SHA` - current sha being built
+* `GIT_URL` - git url
+* `DOTCI_PUSHER` - github username whose git push triggred this build
+* `DOTCI_PULL_REQUEST` - pull request number being built
+* `DOTCI_PULL_REQUEST_SOURCE_BRANCH` - the pull request branch
+* `DOTCI_PULL_REQUEST_TARGET_BRANCH` - the branch the pull request is targeting
diff --git a/docs/user-guide/Templating.md b/docs/user-guide/Templating.md
@@ -1,6 +1,7 @@
 # Templating .ci.yml
 
 ## Environment Variables
+[Environment Variables](EnvironmentVariables.md)
 
 In addition to [Jenkins build
 variables](https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-JenkinsSetEnvironmentVariables),

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,6 +11,7 @@ pages:
     - .ci.yml Plugins Reference: user-guide/Plugins.md
     - .ci.yml Notifications Reference: user-guide/Notifications.md
     - .ci.yml Templating: user-guide/Templating.md
+    - .ci.yml Environment Variables: user-guide/EnvironmentVariables.md
     - Examples : user-guide/Examples.md
     - cli : user-guide/CLI.md
     - UI Reference : user-guide/UI.md