From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Tue, 5 Jun 2018 03:02:16 +0000 (-0400)
Subject: Add Jenkins GitHub integration instructions
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=0d98d20c3afa08eb3b6c3a4ceab0e99a30b7ac96;p=releng%2Fdocs.git

Add Jenkins GitHub integration instructions

Change-Id: I50c48911a62a4dc618d414cf9681a78214939a8d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/infra/jenkins.rst b/docs/infra/jenkins.rst
index 8c63905..ee48f48 100644
--- a/docs/infra/jenkins.rst
+++ b/docs/infra/jenkins.rst
@@ -4,6 +4,8 @@
 Jenkins
 #######
 
+.. _jenkins-upgrade:
+
 Upgrading Jenkins
 =================
 
@@ -33,3 +35,33 @@ Follow these steps to update Jenkins:
 #. Restart the server itself ``systemctl reboot``
 #. Remove Shutdown mode from Jenkins
    (https://jenkins.example.org/cancelQuietDown)
+
+.. _jenkins-github:
+
+GitHub Configuration
+====================
+
+Jenkins requires admin level configuration to work with GitHub.
+
+#. Create a GitHub account for Jenkins to use
+
+   The user needs to have Full Admin access to the GitHub Organization that
+   Jenkins will manage, this is so that Jenkins can automatically manage the
+   hooks.
+
+#. Navigate to ``https://jenkins.example.org/configure``
+#. Under ``GitHub Servers`` click *Advanced* >
+   *Manage GitHub actions* > *Convert login and password to token*
+#. Choose ``From login and password`` and enter the github-jenkins account details
+#. Click Create token credentials
+#. Under ``GitHub Servers`` click *Add GitHub Server* and configure the following:
+
+   .. code-block:: none
+
+      Name: <Leave blank>
+      API URL: https://api.github.com
+      Credentials: <Auto-generated token>
+      Manage hooks: true
+      GitHub client cache size (MB): 20
+
+#. Click ``Re-register hooks for all jobs``