diff options
author | karen Carias <karen@gitlab.com> | 2015-06-23 11:40:26 -0700 |
---|---|---|
committer | karen Carias <karen@gitlab.com> | 2015-06-23 11:40:26 -0700 |
commit | 65eb3aedab6ba79179ab20daa85fab1f294cd4c6 (patch) | |
tree | c1bd017c20ae32ebfb5965be11cb06ace7c913b2 /doc | |
parent | 3825fac65ba2e36620f7d50a8e52fc242ac0d710 (diff) | |
download | gitlab-ci-65eb3aedab6ba79179ab20daa85fab1f294cd4c6.tar.gz |
fixed typos
Diffstat (limited to 'doc')
-rw-r--r-- | doc/builds_configuration/README.md | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/doc/builds_configuration/README.md b/doc/builds_configuration/README.md index 653e32d..0afac2a 100644 --- a/doc/builds_configuration/README.md +++ b/doc/builds_configuration/README.md @@ -1,4 +1,4 @@ -## Configuraton of your builds with .gitlab-ci.yml +## Configuration of your builds with .gitlab-ci.yml From version 7.12, GitLab CI uses a .gitlab-ci.yml file for the configuration of your builds. It is placed in the root of your repository and contains three type of objects: before_script, builds and deploy_builds. Here is an example of how it looks: @@ -46,17 +46,18 @@ rspec: `rspec` is a key of this object and it determines the name of your build -`script` is a shell script which is used by runner. It will be also prepanded with `before_script`. This parameter can also cantain several commands using array: +`script` is a shell script which is used by runner. It will also be prepanded with `before_script`. This parameter can also contain several commands using array: ```yaml script: - uname -a - bundle exec rspec ``` -About `only` and `except` parameters you can read in the [refs settings explanation](#refs-settings-explanation) + +You can read about `only` and `except` parameters in the [refs settings explanation](#refs-settings-explanation) ### deploy_builds -Deploy Builds that will be run when all other builds have succeeded. Define them using simple syntax: +Deploy Builds will be ran when all other builds have succeeded. Define them using simple syntax: ```yaml production: @@ -68,21 +69,24 @@ production: only: - master ``` -`production` - is a name of deploy build. -`script` - is a shell script which will be prepended with `before_script`. +`production` - is a name of deploy build + +`script` - is a shell script which will be prepended with `before_script` + `type: deploy` is a parameter which indicates that it is a deploy job -About `only` and `except` parameters you can read in the [refs settings explanation](#refs-settings-explanation) + +You can read about `only` and `except` parameters in the [refs settings explanation](#refs-settings-explanation) ### before_script -`before_script` is used to define the command that should be ran before all builds, including deploy builds. This can be an array or a multiline string. +`before_script` is used to define the command that should be ran before all builds, including deploy builds. This can be an array or a multiline string ### Refs settings explanation -There are two parameters that help you to set up refs policy for your build or deploy build on CI. +There are two parameters that will help you set up the refs policy for your build or deploy build on CI ``` only: - master ``` -`only` defines exact name of the branch or the tag which will be run. It also supports the regexp expressions: +`only` defines the exact name of the branch or the tag which will be ran. It also supports the regexp expressions: ``` only: @@ -93,17 +97,17 @@ You can also use an `except` parameter: except: - "deploy" ``` -This parameter is used for excluding some refs. It is also supporting regexp expressions. +This parameter is used to exclude some refs. It is also supporting regexp expressions -There are also special keys like `branches` or `tags`. These parameters can be used for excluding all tags or branches. +There are also special keys like `branches` or `tags`. These parameters can be used to exclude all tags or branches ``` except: - branches ``` -## Debugging of your builds with .gitlab-ci.yml +## Debugging your builds with .gitlab-ci.yml -Each instance of GitLab CI has an embeded debug tool Lint. You can find link to the Lint in the projects settings page or use short url `/lint`. +Each instance of GitLab CI has an embeded debug tool Lint. You can find the link to the Lint in the project's settings page or use short url `/lint` ## Skipping builds -There is one more way to skip all builds, if your commit message contains tag [ci skip]. In this case commit will be created but builds will be skipped. +There is one more way to skip all builds, if your commit message contains tag [ci skip]. In this case, commit will be created but builds will be skipped |