Add GitHub DCO setup instructions 40/11140/4
authorThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 8 Jun 2018 15:28:42 +0000 (11:28 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 8 Jun 2018 16:00:28 +0000 (12:00 -0400)
Change-Id: I02987ba54fe72d3f11806f46d2e52b9ee26298dc
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/infra/github.rst [new file with mode: 0644]
docs/infra/index.rst

diff --git a/docs/infra/github.rst b/docs/infra/github.rst
new file mode 100644 (file)
index 0000000..ec54078
--- /dev/null
@@ -0,0 +1,44 @@
+.. _github-infra:
+
+######
+GitHub
+######
+
+.. _github-dco:
+
+Setup DCO
+=========
+
+To setup a DCO we require configuring probot for our GitHub Organization.
+
+#. Navigate to https://github.com/integration/dco
+#. Click ``Configure`` at the top right of the page
+#. Choose the Organization to deploy the DCO to
+#. Set ``All repositories`` and ``Save``
+
+At this point DCO configuration is complete for the organization. Next we need
+to configure each repository to require the DCO.
+
+Navigate to the ``Settings`` page and set the DCO for each repository
+following these steps:
+
+#. Click ``Branches``
+#. Configure ``Branch protection rules`` for each branch which needs
+   DCO enforcement
+#. Set the following configurations:
+
+   * Protect this branch
+   * Require pull request reviews before merging
+   * Dismiss stale pull request approvals when new commits are *pushed*
+   * Require review from Code Owners
+   * Require status checks to pass before merging
+     * DCO
+     * (any verify jobs)
+   * Include administrators
+
+     .. note::
+
+        Status checks will not appear until a job using one of them has ran at
+        least once.
+
+#. Click ``Save``
index 7d1d5aa..f5a0fca 100644 (file)
@@ -15,3 +15,4 @@ Infrastructure provided to projects.
    jenkins
    nexus
    openstack
+   github