diff options
Diffstat (limited to 'doc/ci')
| -rw-r--r-- | doc/ci/README.md | 7 | ||||
| -rw-r--r-- | doc/ci/docker/using_docker_images.md | 4 | ||||
| -rw-r--r-- | doc/ci/examples/README.md | 4 | ||||
| -rw-r--r-- | doc/ci/examples/deployment/README.md | 2 | ||||
| -rw-r--r-- | doc/ci/examples/deployment/composer-npm-deploy.md | 2 | ||||
| -rw-r--r-- | doc/ci/examples/laravel_with_gitlab_and_envoy/index.md | 4 | ||||
| -rw-r--r-- | doc/ci/examples/test-scala-application.md | 2 | ||||
| -rw-r--r-- | doc/ci/git_submodules.md | 2 | ||||
| -rw-r--r-- | doc/ci/jenkins/index.md | 2 | ||||
| -rw-r--r-- | doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md | 2 | ||||
| -rw-r--r-- | doc/ci/multi_project_pipelines.md | 2 | ||||
| -rw-r--r-- | doc/ci/parent_child_pipelines.md | 2 | ||||
| -rw-r--r-- | doc/ci/pipelines/schedules.md | 2 | ||||
| -rw-r--r-- | doc/ci/quick_start/README.md | 2 | ||||
| -rw-r--r-- | doc/ci/runners/README.md | 6 | ||||
| -rw-r--r-- | doc/ci/triggers/README.md | 2 | ||||
| -rw-r--r-- | doc/ci/variables/README.md | 2 | ||||
| -rw-r--r-- | doc/ci/variables/predefined_variables.md | 8 | ||||
| -rw-r--r-- | doc/ci/yaml/README.md | 8 |
19 files changed, 32 insertions, 33 deletions
diff --git a/doc/ci/README.md b/doc/ci/README.md index fe88b414702..f902400efc2 100644 --- a/doc/ci/README.md +++ b/doc/ci/README.md @@ -160,11 +160,10 @@ See also: ### Why GitLab CI/CD? -The following articles explain reasons to use GitLab CI/CD -for your CI/CD infrastructure: +Learn more about: -- [Why we chose GitLab CI for our CI/CD solution](https://about.gitlab.com/blog/2016/10/17/gitlab-ci-oohlala/) -- [Building our web-app on GitLab CI](https://about.gitlab.com/blog/2016/07/22/building-our-web-app-on-gitlab-ci/) +- [Why you might chose GitLab CI/CD](https://about.gitlab.com/blog/2016/10/17/gitlab-ci-oohlala/). +- [Reasons you might migrate from another platform](https://about.gitlab.com/blog/2016/07/22/building-our-web-app-on-gitlab-ci/). - [5 Teams that made the switch to GitLab CI/CD](https://about.gitlab.com/blog/2019/04/25/5-teams-that-made-the-switch-to-gitlab-ci-cd/) See also the [Why CI/CD?](https://docs.google.com/presentation/d/1OGgk2Tcxbpl7DJaIOzCX4Vqg3dlwfELC3u2jEeCBbDk) presentation. diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 4beec62b36b..f56e7a161ca 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -4,7 +4,7 @@ type: concepts, howto # Using Docker images -GitLab CI in conjunction with [GitLab Runner](../runners/README.md) can use +GitLab CI/CD in conjunction with [GitLab Runner](../runners/README.md) can use [Docker Engine](https://www.docker.com/) to test and build any application. Docker is an open-source project that allows you to use predefined images to @@ -12,7 +12,7 @@ run applications in independent "containers" that are run within a single Linux instance. [Docker Hub][hub] has a rich database of pre-built images that can be used to test and build your applications. -When used with GitLab CI, Docker runs each job in a separate and isolated +When used with GitLab CI/CD, Docker runs each job in a separate and isolated container using the predefined image that is set up in [`.gitlab-ci.yml`](../yaml/README.md). diff --git a/doc/ci/examples/README.md b/doc/ci/examples/README.md index d2333f7e468..64367727371 100644 --- a/doc/ci/examples/README.md +++ b/doc/ci/examples/README.md @@ -37,7 +37,7 @@ The following table lists examples with step-by-step tutorials that are containe | Python on Heroku | [Test and deploy a Python application with GitLab CI/CD](test-and-deploy-python-application-to-heroku.md). | | Ruby on Heroku | [Test and deploy a Ruby application with GitLab CI/CD](test-and-deploy-ruby-application-to-heroku.md). | | Scala on Heroku | [Test and deploy a Scala application to Heroku](test-scala-application.md). | -| Parallel testing Ruby & JS | [GitLab CI parallel jobs testing for Ruby & JavaScript projects](https://docs.knapsackpro.com/2019/how-to-run-parallel-jobs-for-rspec-tests-on-gitlab-ci-pipeline-and-speed-up-ruby-javascript-testing). | +| Parallel testing Ruby & JS | [GitLab CI/CD parallel jobs testing for Ruby & JavaScript projects](https://docs.knapsackpro.com/2019/how-to-run-parallel-jobs-for-rspec-tests-on-gitlab-ci-pipeline-and-speed-up-ruby-javascript-testing). | ### Contributing examples @@ -67,7 +67,7 @@ For examples of setting up GitLab CI/CD for cloud-based environments, see: See also the following video overviews: -- [Containers, Schedulers, and GitLab CI](https://www.youtube.com/watch?v=d-9awBxEbvQ). +- [Kubernetes, GitLab, and Cloud Native](https://www.youtube.com/watch?v=d-9awBxEbvQ). - [Deploying to IBM Cloud with GitLab CI/CD](https://www.youtube.com/watch?v=6ZF4vgKMd-g). ### Customer stories diff --git a/doc/ci/examples/deployment/README.md b/doc/ci/examples/deployment/README.md index 01dca801fbc..2ed1a99e0d9 100644 --- a/doc/ci/examples/deployment/README.md +++ b/doc/ci/examples/deployment/README.md @@ -6,7 +6,7 @@ type: tutorial [Dpl](https://github.com/travis-ci/dpl) (pronounced like the letters D-P-L) is a deploy tool made for continuous deployment that's developed and used by Travis CI, but can also be -used with GitLab CI. +used with GitLab CI/CD. Dpl can be used to deploy to any of the [supported providers](https://github.com/travis-ci/dpl#supported-providers). diff --git a/doc/ci/examples/deployment/composer-npm-deploy.md b/doc/ci/examples/deployment/composer-npm-deploy.md index ae0880adef2..c5f49fd6e59 100644 --- a/doc/ci/examples/deployment/composer-npm-deploy.md +++ b/doc/ci/examples/deployment/composer-npm-deploy.md @@ -100,7 +100,7 @@ Here's the breakdown: 1. We will connect again via `ssh` and move the `live` folder to an `_old` folder, then move `_tmp` to `live`. 1. We connect to SSH and remove the `_old` folder -What's the deal with the artifacts? We just tell GitLab CI to keep the `build` directory (later on, you can download that as needed). +What's the deal with the artifacts? We just tell GitLab CI/CD to keep the `build` directory (later on, you can download that as needed). ### Why we do it this way diff --git a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md index 4284038b283..c8f5d48c4ef 100644 --- a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md +++ b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md @@ -608,7 +608,7 @@ If the SSH keys have added successfully, we can run Envoy. As mentioned before, GitLab supports [Continuous Delivery](https://about.gitlab.com/blog/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#continuous-delivery) methods as well. The [environment](../../yaml/README.md#environment) keyword tells GitLab that this job deploys to the `production` environment. The `url` keyword is used to generate a link to our application on the GitLab Environments page. -The `only` keyword tells GitLab CI that the job should be executed only when the pipeline is building the `master` branch. +The `only` keyword tells GitLab CI/CD that the job should be executed only when the pipeline is building the `master` branch. Lastly, `when: manual` is used to turn the job from running automatically to a manual action. ```yaml @@ -679,6 +679,6 @@ As you see, the `.env` is pointing to the `/var/www/app/.env` file and also `sto ## Conclusion -We configured GitLab CI to perform automated tests and used the method of [Continuous Delivery](https://continuousdelivery.com/) to deploy to production a Laravel application with Envoy, directly from the codebase. +We configured GitLab CI/CD to perform automated tests and used the method of [Continuous Delivery](https://continuousdelivery.com/) to deploy to production a Laravel application with Envoy, directly from the codebase. Envoy also was a great match to help us deploy the application without writing our custom bash script and doing Linux magics. diff --git a/doc/ci/examples/test-scala-application.md b/doc/ci/examples/test-scala-application.md index ffdffcc88bd..92fb69286cf 100644 --- a/doc/ci/examples/test-scala-application.md +++ b/doc/ci/examples/test-scala-application.md @@ -4,7 +4,7 @@ type: tutorial # Test and deploy a Scala application to Heroku -This example demonstrates the integration of GitLab CI with Scala +This example demonstrates the integration of GitLab CI/CD with Scala applications using SBT. You can view or fork the [example project](https://gitlab.com/gitlab-examples/scala-sbt) and view the logs of its past [CI jobs](https://gitlab.com/gitlab-examples/scala-sbt/-/jobs?scope=finished). diff --git a/doc/ci/git_submodules.md b/doc/ci/git_submodules.md index cce33c7a6b4..381c0508dea 100644 --- a/doc/ci/git_submodules.md +++ b/doc/ci/git_submodules.md @@ -44,7 +44,7 @@ for all your local checkouts. The `.gitmodules` would look like: The above configuration will instruct Git to automatically deduce the URL that should be used when cloning sources. Whether you use HTTP(S) or SSH, Git will use that same channel and it will allow to make all your CI jobs use HTTP(S) -(because GitLab CI only uses HTTP(S) for cloning your sources), and all your local +(because GitLab CI/CD only uses HTTP(S) for cloning your sources), and all your local clones will continue using SSH. For all other submodules not located on the same GitLab server, use the full diff --git a/doc/ci/jenkins/index.md b/doc/ci/jenkins/index.md index 37d6921c0a5..9b72d0bfb5e 100644 --- a/doc/ci/jenkins/index.md +++ b/doc/ci/jenkins/index.md @@ -243,7 +243,7 @@ default: #### `stages` -GitLab CI also lets you define stages, but is a little bit more free-form to configure. The GitLab [`stages` keyword](../yaml/README.md#stages) +GitLab CI/CD also lets you define stages, but is a little bit more free-form to configure. The GitLab [`stages` keyword](../yaml/README.md#stages) is a top level setting that enumerates the list of stages, but you are not required to nest individual jobs underneath the `stages` section. Any job defined in the `.gitlab-ci.yml` can be made a part of any stage through use of the [`stage:` keyword](../yaml/README.md#stage). diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md index bab03f11aa8..7983dded814 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md @@ -66,7 +66,7 @@ otherwise pipelines for merged results won't run and your merge requests will be > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/12996) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.3. -GitLab CI can detect the presence of redundant pipelines, +GitLab CI/CD can detect the presence of redundant pipelines, and will cancel them automatically in order to conserve CI resources. When a user merges a merge request immediately within an ongoing merge diff --git a/doc/ci/multi_project_pipelines.md b/doc/ci/multi_project_pipelines.md index 6a4dff635ad..09fb5e3a7b9 100644 --- a/doc/ci/multi_project_pipelines.md +++ b/doc/ci/multi_project_pipelines.md @@ -39,7 +39,7 @@ With Multi-Project Pipelines you can visualize the entire pipeline, including al > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2121) in [GitLab Premium 9.3](https://about.gitlab.com/releases/2017/06/22/gitlab-9-3-released/#multi-project-pipeline-graphs). -When you configure GitLab CI for your project, you can visualize the stages of your +When you configure GitLab CI/CD for your project, you can visualize the stages of your [jobs](pipelines/index.md#configuring-pipelines) on a [pipeline graph](pipelines/index.md#visualizing-pipelines).  diff --git a/doc/ci/parent_child_pipelines.md b/doc/ci/parent_child_pipelines.md index 2ce69a04939..b39e0b6e540 100644 --- a/doc/ci/parent_child_pipelines.md +++ b/doc/ci/parent_child_pipelines.md @@ -33,7 +33,7 @@ set of concurrently running child pipelines, but within the same project: - Imports are done at the child pipeline level, reducing the likelihood of collisions. - Each pipeline has only relevant steps, making it easier to understand what's going on. -Child pipelines work well with other GitLab CI features: +Child pipelines work well with other GitLab CI/CD features: - Use [`only: changes`](yaml/README.md#onlychangesexceptchanges) to trigger pipelines only when certain files change. This is useful for monorepos, for example. diff --git a/doc/ci/pipelines/schedules.md b/doc/ci/pipelines/schedules.md index b9a2972dc89..0ca794c5411 100644 --- a/doc/ci/pipelines/schedules.md +++ b/doc/ci/pipelines/schedules.md @@ -46,7 +46,7 @@ is installed on. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12328) in GitLab 9.4. You can pass any number of arbitrary variables and they will be available in -GitLab CI so that they can be used in your [`.gitlab-ci.yml` file](../../ci/yaml/README.md). +GitLab CI/CD so that they can be used in your [`.gitlab-ci.yml` file](../../ci/yaml/README.md).  diff --git a/doc/ci/quick_start/README.md b/doc/ci/quick_start/README.md index 0ea37e26224..8ef78f899c7 100644 --- a/doc/ci/quick_start/README.md +++ b/doc/ci/quick_start/README.md @@ -55,7 +55,7 @@ This guide assumes that you have: - A project in GitLab that you would like to use CI for. - Maintainer or owner access to the project -Let's break it down to pieces and work on solving the GitLab CI puzzle. +Let's break it down to pieces and work on solving the GitLab CI/CD puzzle. ## Creating a `.gitlab-ci.yml` file diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index 7e1aae4709a..3b9e30e2b96 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -4,12 +4,12 @@ type: reference # Configuring GitLab Runners -In GitLab CI, Runners run the code defined in [`.gitlab-ci.yml`](../yaml/README.md). +In GitLab CI/CD, Runners run the code defined in [`.gitlab-ci.yml`](../yaml/README.md). They are isolated (virtual) machines that pick up jobs through the coordinator -API of GitLab CI. +API of GitLab CI/CD. A Runner can be specific to a certain project or serve any project -in GitLab CI. A Runner that serves all projects is called a shared Runner. +in GitLab CI/CD. A Runner that serves all projects is called a shared Runner. Ideally, the GitLab Runner should not be installed on the same machine as GitLab. Read the [requirements documentation](../../install/requirements.md#gitlab-runner) diff --git a/doc/ci/triggers/README.md b/doc/ci/triggers/README.md index 00070594ded..98d3a08977c 100644 --- a/doc/ci/triggers/README.md +++ b/doc/ci/triggers/README.md @@ -192,7 +192,7 @@ https://gitlab.example.com/api/v4/projects/9/ref/master/trigger/pipeline?token=T ## Making use of trigger variables You can pass any number of arbitrary variables in the trigger API call and they -will be available in GitLab CI so that they can be used in your `.gitlab-ci.yml` +will be available in GitLab CI/CD so that they can be used in your `.gitlab-ci.yml` file. The parameter is of the form: ```plaintext diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 5a6d30a1079..af41d1ab958 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -317,7 +317,7 @@ export GITLAB_USER_ID="42" NOTE: **Note:** This feature requires GitLab Runner 0.5.0 or higher and GitLab 7.14 or higher. -GitLab CI allows you to add to `.gitlab-ci.yml` variables that are set in the +GitLab CI/CD allows you to add to `.gitlab-ci.yml` variables that are set in the build environment. The variables are hence saved in the repository, and they are meant to store non-sensitive project configuration. For example, `RAILS_ENV` or `DATABASE_URL`. diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index c90d2e1aa5e..0fab965a0c0 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -56,7 +56,7 @@ future GitLab releases.** | `CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA` | 12.3 | all | The HEAD SHA of the source branch of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME` | 12.3 | all | The target branch name of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA` | 12.3 | all | The HEAD SHA of the target branch of the pull request if [the pipelines are for external pull requests](../ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). Available only if `only: [external_pull_requests]` or [`rules`](../yaml/README.md#rules) syntax is used and the pull request is open. | -| `CI_JOB_ID` | 9.0 | all | The unique id of the current job that GitLab CI uses internally | +| `CI_JOB_ID` | 9.0 | all | The unique id of the current job that GitLab CI/CD uses internally | | `CI_JOB_IMAGE` | 12.9 | 12.9 | The name of the image running the CI job | | `CI_JOB_MANUAL` | 8.12 | all | The flag to indicate that job was manually started | | `CI_JOB_NAME` | 9.0 | 0.5 | The name of the job as defined in `.gitlab-ci.yml` | @@ -87,13 +87,13 @@ future GitLab releases.** | `CI_NODE_TOTAL` | 11.5 | all | Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to `1`. | | `CI_PAGES_DOMAIN` | 11.8 | all | The configured domain that hosts GitLab Pages. | | `CI_PAGES_URL` | 11.8 | all | URL to GitLab Pages-built pages. Always belongs to a subdomain of `CI_PAGES_DOMAIN`. | -| `CI_PIPELINE_ID` | 8.10 | all | The unique id of the current pipeline that GitLab CI uses internally | +| `CI_PIPELINE_ID` | 8.10 | all | The unique id of the current pipeline that GitLab CI/CD uses internally | | `CI_PIPELINE_IID` | 11.0 | all | The unique id of the current pipeline scoped to project | | `CI_PIPELINE_SOURCE` | 10.0 | all | Indicates how the pipeline was triggered. Possible options are: `push`, `web`, `trigger`, `schedule`, `api`, `pipeline`, `external`, `chat`, `merge_request_event`, and `external_pull_request_event`. For pipelines created before GitLab 9.5, this will show as `unknown` | | `CI_PIPELINE_TRIGGERED` | all | all | The flag to indicate that job was [triggered](../triggers/README.md) | | `CI_PIPELINE_URL` | 11.1 | 0.5 | Pipeline details URL | | `CI_PROJECT_DIR` | all | all | The full path where the repository is cloned and where the job is run. If the GitLab Runner `builds_dir` parameter is set, this variable is set relative to the value of `builds_dir`. For more information, see [Advanced configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) for GitLab Runner. | -| `CI_PROJECT_ID` | all | all | The unique id of the current project that GitLab CI uses internally | +| `CI_PROJECT_ID` | all | all | The unique id of the current project that GitLab CI/CD uses internally | | `CI_PROJECT_NAME` | 8.10 | 0.5 | The name of the directory for the project that is currently being built. For example, if the project URL is `gitlab.example.com/group-name/project-1`, the `CI_PROJECT_NAME` would be `project-1`. | | `CI_PROJECT_NAMESPACE` | 8.10 | 0.5 | The project namespace (username or groupname) that is currently being built | | `CI_PROJECT_PATH` | 8.10 | 0.5 | The namespace with project name | @@ -127,7 +127,7 @@ future GitLab releases.** | `CI_SERVER_VERSION_PATCH` | 11.4 | all | GitLab version patch component | | `CI_SHARED_ENVIRONMENT` | all | 10.1 | Marks that the job is executed in a shared environment (something that is persisted across CI invocations like `shell` or `ssh` executor). If the environment is shared, it is set to true, otherwise it is not defined at all. | | `GET_SOURCES_ATTEMPTS` | 8.15 | 1.9 | Number of attempts to fetch sources running a job | -| `GITLAB_CI` | all | all | Mark that job is executed in GitLab CI environment | +| `GITLAB_CI` | all | all | Mark that job is executed in GitLab CI/CD environment | | `GITLAB_FEATURES` | 10.6 | all | The comma separated list of licensed features available for your instance and plan | | `GITLAB_USER_EMAIL` | 8.12 | all | The email of the user who started the job | | `GITLAB_USER_ID` | 8.12 | all | The id of the user who started the job | diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 5fe0f70b519..0930185371a 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -18,7 +18,7 @@ This topic covers CI/CD pipeline configuration. For other CI/CD configuration in We have complete examples of configuring pipelines: -- For a quick introduction to GitLab CI, follow our [quick start guide](../quick_start/README.md). +- For a quick introduction to GitLab CI/CD, follow our [quick start guide](../quick_start/README.md). - For a collection of examples, see [GitLab CI/CD Examples](../examples/README.md). - To see a large `.gitlab-ci.yml` file used in an enterprise, see the [`.gitlab-ci.yml` file for `gitlab`](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab-ci.yml). @@ -58,7 +58,7 @@ independently from each other. ### Validate the `.gitlab-ci.yml` -Each instance of GitLab CI has an embedded debug tool called Lint, which validates the +Each instance of GitLab CI/CD has an embedded debug tool called Lint, which validates the content of your `.gitlab-ci.yml` files. You can find the Lint under the page `ci/lint` of your project namespace. For example, `https://gitlab.example.com/gitlab-org/project-123/-/ci/lint`. @@ -312,7 +312,7 @@ For: - Simple definition examples, see [Define `image` and `services` from `.gitlab-ci.yml`](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml). - Detailed usage information, refer to [Docker integration](../docker/README.md) documentation. -- For example services, see [GitLab CI Services](../services/README.md). +- For example services, see [GitLab CI/CD Services](../services/README.md). #### `services:name` @@ -3958,7 +3958,7 @@ lines where the job is defined: ``` you can instead start its name with a dot (`.`) and it will not be processed by -GitLab CI. In the following example, `.hidden_job` will be ignored: +GitLab CI/CD. In the following example, `.hidden_job` will be ignored: ```yaml .hidden_job: |