summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorValery Sizov <vsv2711@gmail.com>2015-05-28 17:59:19 +0300
committerValery Sizov <vsv2711@gmail.com>2015-06-03 16:35:57 +0300
commit2999c8b41f8272b239e4364867012c9e3d4a997a (patch)
treeea3fca536ea22c25e5ea57c11bdbc2a56da2c8fe /doc
parent17a8fe8a9011cfde0a9dbe70d726c769819a9dfd (diff)
downloadgitlab-ci-2999c8b41f8272b239e4364867012c9e3d4a997a.tar.gz
cleaning up
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md1
-rw-r--r--doc/api/commits.md6
-rw-r--r--doc/api/projects.md59
-rw-r--r--doc/jobs/README.md60
-rw-r--r--doc/jobs/deploy_job.pngbin105081 -> 0 bytes
-rw-r--r--doc/jobs/job.pngbin113858 -> 0 bytes
6 files changed, 3 insertions, 123 deletions
diff --git a/doc/README.md b/doc/README.md
index a300654..948b146 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -4,7 +4,6 @@
+ [Examples](examples/README.md)
+ [Install](install/installation.md)
+ [Update](update/README.md)
-+ [Jobs](jobs/README.md)
+ [Runners](runners/README.md)
+ [Permissions](permissions/README.md) User permissions
+ [Rake Tasks](raketasks/README.md) Backup and restore take tasks
diff --git a/doc/api/commits.md b/doc/api/commits.md
index b348e23..f45d883 100644
--- a/doc/api/commits.md
+++ b/doc/api/commits.md
@@ -47,8 +47,7 @@ Returns:
"runner_id": 1,
"coverage": null,
"commit_id": 3,
- "commands": "git submodule update --init\nls -la\n",
- "job_id": 3
+ "commands": "git submodule update --init\nls -la\n"
}]
}]
```
@@ -98,8 +97,7 @@ Returns:
"runner_id": 1,
"coverage": null,
"commit_id": 3,
- "commands": "git submodule update --init\nls -la\n",
- "job_id": 3
+ "commands": "git submodule update --init\nls -la\n"
}]
}
```
diff --git a/doc/api/projects.md b/doc/api/projects.md
index bdc9862..c24d48f 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -151,61 +151,4 @@ via authorized user).
Parameters:
* `id` (required) - The ID of the Gitlab CI project
- * `runner_id` (required) - The ID of the Gitlab CI runner
-
-### List All Jobs for a Project
-
-List the jobs associated to a Gitlab CI Project (only via
-authorized user).
-
- GET /projects/:id/jobs
-
-Parameters:
-
- * `id` (required) - The ID of the Gitlab CI project
-
-### Add a parallel Job to a Project
-
-Adds a Job to a Gitlab CI Project (only via
-authorized user).
-
- POST /projects/:id/jobs
-
-Parameters:
-
- * `id` (required) - The ID of the Gitlab CI project
- * `name` (required) - The name of the Job to add
- * `commands` (required) - The script commands of the job
- * `active` (optional) - The command is active of not
- * `build_branches` (optional) - Trigger commit builds
- * `build_tags` (optional) - Trigger tag builds
- * `tags` (optional) - The tags associated with this job
-
-### Add a deploy Job to a Project
-
-Adds a deploy Job to a Gitlab CI Project (only via
-authorized user).
-
- POST /projects/:id/deploy_jobs
-
-Parameters:
-
- * `id` (required) - The ID of the Gitlab CI project
- * `name` (required) - The name of the Job to add
- * `commands` (required) - The script commands of the job
- * `active` (optional) - The command is active of not
- * `refs` (optional) - The list of refs
- * `tags` (optional) - The tags associated with this job
-
-### Remove a Job from a Project
-
-Removes a Job from a Gitlab CI Project (only
-via authorized user).
-
- DELETE /projects/:id/jobs/:job_id
-
-Parameters:
-
- * `id` (required) - The ID of the Gitlab CI project
- * `job_id` (required) - The ID of the Job
-
+ * `runner_id` (required) - The ID of the Gitlab CI runner \ No newline at end of file
diff --git a/doc/jobs/README.md b/doc/jobs/README.md
deleted file mode 100644
index ab98e0e..0000000
--- a/doc/jobs/README.md
+++ /dev/null
@@ -1,60 +0,0 @@
-# Jobs
-
-Jobs are user-created shell scripts. On each push to GitLab the CI creates builds for each job.
-Every build is served by runners on which the shell scripts from these jobs are ran.
-There are two types of jobs: test jobs (ran in parallel) and deploy jobs (ran on success).
-
-### Test job (run in parallel)
-
-![Jobs](job.png)
-
-These kind of jobs run in parallel and can be useful for test suites.
-For example, to save time you can run one part of your test suite in one build
-and a second part in another build.
-
-Fields:
-
-`name` - an arbitrary name of a job
-
-`builds commit` (checkbox) - check this if you want to create a build on
-pushes of regular commits and branches
-
-`build tag` (checkbox) - check this if you want to start a build on each tag pushed
-
-_For example, for GitLab we created a job for building packages. We want packages to be built when we push
-new tags. So what we did is disable `builds commit` and we enabled `build tag`._
-
-`tags` - the list of tags (ex. "ruby mysql silenium"), only runners that contain the same set of tags can perform this build.
-
-Script - your shell script to run. Example for rails projects:
-
-```
-export PATH=~/bin:/usr/local/bin:/usr/bin:/bin
-gem install bundler
-cp config/database.yml.mysql config/database.yml
-cp config/application.yml.example config/application.yml
-bundle
-RAILS_ENV=test bundle exec rake db:setup
-RAILS_ENV=test bundle exec rake spec
-```
-
-
-### Deploy jobs (ran on success)
-
-![Deploy jobs](deploy_job.png)
-
-This type of jobs runs after all test jobs pass.
-It is especially useful for deploying applications.
-For example, if you want to make sure that whole test suite passes before each deploy.
-
-Fields:
-
-`name` - an arbitrary name of the deploy job
-
-`tags` - Just like test jobs, you probably have a specific runner in mind
-that can deploy your code, as this runner needs special permissions, for instance.
-Here you can set the tags for the runners that are allowed to run the deploy job.
-
-`refs` - Here you can specify git refs that should trigger a deploy job
-
-`script` - The actual shell script to run.
diff --git a/doc/jobs/deploy_job.png b/doc/jobs/deploy_job.png
deleted file mode 100644
index f940710..0000000
--- a/doc/jobs/deploy_job.png
+++ /dev/null
Binary files differ
diff --git a/doc/jobs/job.png b/doc/jobs/job.png
deleted file mode 100644
index 760d107..0000000
--- a/doc/jobs/job.png
+++ /dev/null
Binary files differ