summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Lebon <jlebon@redhat.com>2017-06-13 10:16:07 -0400
committerJonathan Lebon <jlebon@redhat.com>2017-06-14 13:28:37 -0400
commitd840f53aaaf4243c412ed1652ea74bccedcaa54b (patch)
tree4fa2b36bf878a4c14501fecc69e44b0801e9d926
parentef2f54d7c48458c0f65a0953c6900e541b46328d (diff)
downloadopenshift-d840f53aaaf4243c412ed1652ea74bccedcaa54b.tar.gz
openshift-d840f53aaaf4243c412ed1652ea74bccedcaa54b.tar.bz2
openshift-d840f53aaaf4243c412ed1652ea74bccedcaa54b.tar.xz
openshift-d840f53aaaf4243c412ed1652ea74bccedcaa54b.zip
docs: better documentation for PAPR
Add a section in `repo_structure.md`, and rename from `redhat-ci` to `PAPR` and point to the new upstream repo in `pull_requests.md`. Closes: #4078
-rw-r--r--docs/pull_requests.md8
-rw-r--r--docs/repo_structure.md13
2 files changed, 17 insertions, 4 deletions
diff --git a/docs/pull_requests.md b/docs/pull_requests.md
index fcc3e275c..45ae01a9d 100644
--- a/docs/pull_requests.md
+++ b/docs/pull_requests.md
@@ -10,8 +10,8 @@ Whenever a
[Pull Request is opened](../CONTRIBUTING.md#submitting-contributions), some
automated test jobs must be successfully run before the PR can be merged.
-Some of these jobs are automatically triggered, e.g., Travis and Coveralls.
-Other jobs need to be manually triggered by a member of the
+Some of these jobs are automatically triggered, e.g., Travis, PAPR, and
+Coveralls. Other jobs need to be manually triggered by a member of the
[Team OpenShift Ansible Contributors](https://github.com/orgs/openshift/teams/team-openshift-ansible-contributors).
## Triggering tests
@@ -48,9 +48,9 @@ simplifying the workflow towards a single infrastructure in the future.
There are a set of tests that run on Fedora infrastructure. They are started
automatically with every pull request.
-They are implemented using the [`redhat-ci` framework](https://github.com/jlebon/redhat-ci).
+They are implemented using the [`PAPR` framework](https://github.com/projectatomic/papr).
-To re-run tests, write a comment containing `bot, retest this please`.
+To re-run tests, write a comment containing only `bot, retest this please`.
## Triggering merge
diff --git a/docs/repo_structure.md b/docs/repo_structure.md
index 693837fba..f598f22c3 100644
--- a/docs/repo_structure.md
+++ b/docs/repo_structure.md
@@ -52,3 +52,16 @@ These are plugins used in playbooks and roles:
.
└── test Contains tests.
```
+
+### CI
+
+These files are used by [PAPR](https://github.com/projectatomic/papr),
+It is very similar in workflow to Travis, with the test
+environment and test scripts defined in a YAML file.
+
+```
+.
+├── .papr.yml
+├── .papr.sh
+└── .papr.inventory
+```