summaryrefslogtreecommitdiff
path: root/qa/README.md
diff options
context:
space:
mode:
authorStan Hu <stanhu@gmail.com>2017-09-29 23:38:12 -0700
committerStan Hu <stanhu@gmail.com>2017-09-29 23:38:12 -0700
commit5d46236f7615859ddc1c3591169e1d0dd39b4597 (patch)
treedc4a3117fd575f874fcb3251eb166767e2c78928 /qa/README.md
parent171714c9231deb95136088ba1c0621379467de39 (diff)
downloadgitlab-ce-5d46236f7615859ddc1c3591169e1d0dd39b4597.tar.gz
Add GitLab QA documentation
[ci skip]
Diffstat (limited to 'qa/README.md')
-rw-r--r--qa/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/qa/README.md b/qa/README.md
index b6b5a76f1d3..e0ebb53a2e9 100644
--- a/qa/README.md
+++ b/qa/README.md
@@ -16,3 +16,22 @@ against any existing instance.
1. When we release a new version of GitLab, we build a Docker images for it.
1. Along with GitLab Docker Images we also build and publish GitLab QA images.
1. GitLab QA project uses these images to execute integration tests.
+
+## How can I use it?
+
+You can use GitLab QA to exercise tests on any live instance! For example, the
+follow call would login to the local GitLab instance and run all specs in
+`qa/specs/features`:
+
+```
+GITLAB_USERNAME='root' GITLAB_PASSWORD='5iveL!fe' bin/qa Test::Instance http://localhost
+```
+
+You can also supply a specific tests to run as another parameter. For example, to
+test the EE license specs, you can run:
+
+```
+EE_LICENSE="<YOUR LICENSE KEY>" GITLAB_USERNAME='root' GITLAB_PASSWORD='5iveL!fe' bin/qa Test::Instance http://localhost qa/ee
+```
+
+All [supported environment variables are here](https://gitlab.com/gitlab-org/gitlab-qa#supported-environment-variables).