From: Thanh Ha Date: Fri, 8 Jun 2018 15:28:42 +0000 (-0400) Subject: Add GitHub DCO setup instructions X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=99c6d3dd62de646edc5e4a9067eb79f1a8ab8eb2;p=releng%2Fdocs.git Add GitHub DCO setup instructions Change-Id: I02987ba54fe72d3f11806f46d2e52b9ee26298dc Signed-off-by: Thanh Ha --- diff --git a/docs/infra/github.rst b/docs/infra/github.rst new file mode 100644 index 0000000..ec54078 --- /dev/null +++ b/docs/infra/github.rst @@ -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`` diff --git a/docs/infra/index.rst b/docs/infra/index.rst index 7d1d5aa..f5a0fca 100644 --- a/docs/infra/index.rst +++ b/docs/infra/index.rst @@ -15,3 +15,4 @@ Infrastructure provided to projects. jenkins nexus openstack + github