Skip to content
This repository was archived by the owner on May 12, 2018. It is now read-only.

Commit ba65f00

Browse files
committed
Enhance readme.
1 parent 9954efb commit ba65f00

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,27 @@
99

1010
### Requirements
1111

12-
GitLab CI is designed for the Linux operating system.
13-
1412
GitLab CI officially supports (recent versions of) these Linux distributions:
1513

1614
* Ubuntu Linux
1715
* Debian/GNU Linux
1816

1917
Additionally GitLab CI requires:
2018

19+
* GitLab 6.0+
2120
* ruby 1.9.3
2221
* MySQL or PostgreSQL
2322

24-
This version (3.x) is designed for GitLab 5.3+.
25-
26-
__If you want to use GitLab CI without GitLab or with older versions you need to use [2-2-stable](https://github.com/gitlabhq/gitlab-ci/tree/2-2-stable#gitlab-ci-is-an-open-source-continuous-integration-server)__
23+
__If you want to use GitLab CI without GitLab or with older versions of GitLab you need to use [2-2-stable](https://github.com/gitlabhq/gitlab-ci/tree/2-2-stable#gitlab-ci-is-an-open-source-continuous-integration-server)__
2724

28-
### How it works
25+
### Architecture
2926

30-
__GitLab CI__ is a web application with API and connect to db.
31-
It manage projects/builds and provide a nice user interface.
32-
It uses GitLab application to authenticate users.
27+
__GitLab CI__ is a web application with an API and it connect to the db.
28+
It manage projects/builds and provides a nice user interface.
29+
It uses the GitLab application API to authenticate users.
3330

34-
__GitLab CI Runner__ is a pure ruby application which process builds.
35-
It can be deployed separately and work with GitLab CI through API.
31+
__GitLab CI Runner__ is a pure ruby application which processes builds.
32+
It can be deployed separately and works with GitLab CI through an API.
3633

3734
In order to run tests you need at least 1 __GitLab CI__ instance and 1 __GitLab CI Runner__.
3835
However, for running several builds at the same time you may want to setup more than one __GitLab CI Runner__.
@@ -45,18 +42,36 @@ Possible Cases:
4542

4643
![screen](https://raw.github.com/gitlabhq/gitlab-ci/master/app/assets/images/arch.jpg)
4744

48-
The runner runs the line below and then runs the commands in your projects settings
49-
50-
cd /gitlab-ci-runner/tmp/builds && git clone git@gitlab_server_fqdn:group/project.git project-1 && cd project-1 && git checkout master
51-
5245
For more information see:
5346
[Announcing GitLab CI 3.0](http://blog.gitlab.org/announcing-gitlab-ci-3.0/)
5447
and
5548
[Integrating GitLab CI With GitLab to Enable Distributed Builds](http://blog.gitlab.org/integrating-gitlab-ci-with-gitlab/)
5649

5750
### Installation
5851

59-
* [Installation and setup guide](https://github.com/gitlabhq/gitlab-ci/blob/master/doc/installation.md)
52+
* [Installation guide](https://github.com/gitlabhq/gitlab-ci/blob/master/doc/installation.md)
53+
54+
### How to add a new project to GitLab CI
55+
56+
1) Log in the GitLab CI web interface
57+
2) Press the 'Sync now' button
58+
3) Select your project with the 'Add' button
59+
4) Go the the Integration page and do the 'Complete (as service)' steps
60+
5) Go to the settings page to add a build script (see below for an example)
61+
6) Push a new commit to the project
62+
7) If the build fails then adjust the build script and press the 'Retry' button on the build page
63+
8) If the build is green you are done, all new commits will be tested and you see the status of merge requests builds within GitLab
64+
65+
For your information, the runner runs the line below and then runs the commands in your build script:
66+
67+
cd /gitlab-ci-runner/tmp/builds && git clone git@gitlab_server_fqdn:group/project.git project-1 && cd project-1 && git checkout master
68+
69+
Build script example:
70+
71+
bundle install
72+
bundle exec rake db:create RAILS_ENV=test
73+
bundle exec rake db:migrate RAILS_ENV=test
74+
script/run_all_tests
6075

6176
### Getting help
6277

0 commit comments

Comments
 (0)