From bc68bccab507b244f5246cb3449e8dfd0662d573 Mon Sep 17 00:00:00 2001 From: Manu Date: Fri, 25 Aug 2017 21:03:37 +0000 Subject: Added missing `S` to CI documentation for using SSh keys --- doc/ci/ssh_keys/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/ci') diff --git a/doc/ci/ssh_keys/README.md b/doc/ci/ssh_keys/README.md index cf25a8b618f..cdb9858e179 100644 --- a/doc/ci/ssh_keys/README.md +++ b/doc/ci/ssh_keys/README.md @@ -42,7 +42,7 @@ It is also good practice to check the server's own public key to make sure you are not being targeted by a man-in-the-middle attack. To do this, add another variable named `SSH_SERVER_HOSTKEYS`. To find out the hostkeys of your server, run the `ssh-keyscan YOUR_SERVER` command from a trusted network (ideally, from the -server itself), and paste its output into the `SSH_SERVER_HOSTKEY` variable. If +server itself), and paste its output into the `SSH_SERVER_HOSTKEYS` variable. If you need to connect to multiple servers, concatenate all the server public keys that you collected into the **Value** of the variable. There must be one key per line. -- cgit v1.2.1 From 9dd8af01fee78b828cfe3b6c8395a57d7a3d011a Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Fri, 25 Aug 2017 23:48:57 +0900 Subject: Squashed commit of the following: commit 79858a631af97c2857700fa44c0e7ba09d621e12 Author: Shinya Maeda Date: Fri Aug 25 23:33:04 2017 +0900 Fix doc commit d0c864c7f1522bd254458a7d6e1002352f34a143 Author: Shinya Maeda Date: Tue Aug 22 22:27:32 2017 +0900 Add tests commit 1628eb8598f8ad0e6b573f3fb4fdcf5c3776885b Author: Shinya Maeda Date: Tue Aug 22 10:14:44 2017 +0000 Update .gitlab-ci.yml commit 440a3cdd0bb5d7b83f861f6d3762510b40df984a Author: Shinya Maeda Date: Fri Aug 18 14:46:56 2017 +0000 Update build.rb commit e925951e35c889bfc0520ce056e7df7befdeb93b Author: Shinya Maeda Date: Thu Aug 17 18:13:17 2017 +0900 Add changelog commit 7de5b4f50fc1ff6987c9a861c057c816d4fb285d Author: Shinya Maeda Date: Thu Aug 17 18:11:53 2017 +0900 ini --- doc/ci/examples/README.md | 5 ++++- doc/ci/examples/code_climate.md | 8 +++++--- 2 files changed, 9 insertions(+), 4 deletions(-) (limited to 'doc/ci') diff --git a/doc/ci/examples/README.md b/doc/ci/examples/README.md index 2458cb959ab..f094546c3bd 100644 --- a/doc/ci/examples/README.md +++ b/doc/ci/examples/README.md @@ -50,12 +50,15 @@ Apart from those, here is an collection of tutorials and guides on setting up yo - **Articles:** - [Setting up GitLab CI for Android projects](https://about.gitlab.com/2016/11/30/setting-up-gitlab-ci-for-android-projects/) +### Code quality analysis + +- [Analyze code quality with the Code Climate CLI](code_climate.md) + ### Other - [Using `dpl` as deployment tool](deployment/README.md) - [Repositories with examples for various languages](https://gitlab.com/groups/gitlab-examples) - [The .gitlab-ci.yml file for GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab-ci.yml) -- [Analyze code quality with the Code Climate CLI](code_climate.md) - **Articles:** - [Continuous Deployment with GitLab: how to build and deploy a Debian Package with GitLab CI](https://about.gitlab.com/2016/10/12/automated-debian-package-build-with-gitlab-ci/) diff --git a/doc/ci/examples/code_climate.md b/doc/ci/examples/code_climate.md index 5659a8c2a2a..b9963995ca7 100644 --- a/doc/ci/examples/code_climate.md +++ b/doc/ci/examples/code_climate.md @@ -5,10 +5,10 @@ GitLab CI and Docker. First, you need GitLab Runner with [docker-in-docker executor][dind]. -Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codeclimate`: +Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality` or `codeclimate`(DEPRECATED[^1]): ```yaml -codeclimate: +codequality: image: docker:latest variables: DOCKER_DRIVER: overlay @@ -22,13 +22,15 @@ codeclimate: paths: [codeclimate.json] ``` -This will create a `codeclimate` job in your CI pipeline and will allow you to +This will create a `codequality` job in your CI pipeline and will allow you to download and analyze the report artifact in JSON format. For GitLab [Enterprise Edition Starter][ee] users, this information can be automatically extracted and shown right in the merge request widget. [Learn more on code quality diffs in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html). +[^1]: This is scheduled to be removed in 11.0. + [cli]: https://github.com/codeclimate/codeclimate [dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor [ee]: https://about.gitlab.com/gitlab-ee/ -- cgit v1.2.1 From 16719ce107c174b97da1b0e2730ff548aa39a4aa Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Thu, 31 Aug 2017 15:57:31 +0900 Subject: fix doc --- doc/ci/examples/code_climate.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'doc/ci') diff --git a/doc/ci/examples/code_climate.md b/doc/ci/examples/code_climate.md index b9963995ca7..4d0ba8bfef3 100644 --- a/doc/ci/examples/code_climate.md +++ b/doc/ci/examples/code_climate.md @@ -5,7 +5,7 @@ GitLab CI and Docker. First, you need GitLab Runner with [docker-in-docker executor][dind]. -Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality` or `codeclimate`(DEPRECATED[^1]): +Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality`: ```yaml codequality: @@ -29,8 +29,6 @@ For GitLab [Enterprise Edition Starter][ee] users, this information can be autom extracted and shown right in the merge request widget. [Learn more on code quality diffs in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html). -[^1]: This is scheduled to be removed in 11.0. - [cli]: https://github.com/codeclimate/codeclimate [dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor [ee]: https://about.gitlab.com/gitlab-ee/ -- cgit v1.2.1 From a9394fc9ea9871a2c81e65341ef21eca5e920adb Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Thu, 31 Aug 2017 10:17:01 -0300 Subject: index article from CI index --- doc/ci/README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/ci') diff --git a/doc/ci/README.md b/doc/ci/README.md index c722d895f42..d0c7f32a242 100644 --- a/doc/ci/README.md +++ b/doc/ci/README.md @@ -112,6 +112,7 @@ Here is an collection of tutorials and guides on setting up your CI pipeline. - [Run PHP Composer & NPM scripts then deploy them to a staging server](examples/deployment/composer-npm-deploy.md) - [Analyze code quality with the Code Climate CLI](examples/code_climate.md) - **Articles** + - [How to test and deploy Laravel/PHP applications with GitLab CI/CD and Envoy](../articles/test_and_deploy_laravel_apps_with_gitlab_ci_and_envoy/index.md) - [How to deploy Maven projects to Artifactory with GitLab CI/CD](../articles/artifactory_and_gitlab/index.md) - [Automated Debian packaging](https://about.gitlab.com/2016/10/12/automated-debian-package-build-with-gitlab-ci/) - [Spring boot application with GitLab CI and Kubernetes](https://about.gitlab.com/2016/12/14/continuous-delivery-of-a-spring-boot-application-with-gitlab-ci-and-kubernetes/) -- cgit v1.2.1 From ad64668b5767b2f2e6e512aa259ac5fd92df7d6c Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Thu, 31 Aug 2017 13:12:59 -0300 Subject: reduce the dir name --- doc/ci/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/ci') diff --git a/doc/ci/README.md b/doc/ci/README.md index d0c7f32a242..1bf10e34ae7 100644 --- a/doc/ci/README.md +++ b/doc/ci/README.md @@ -112,7 +112,7 @@ Here is an collection of tutorials and guides on setting up your CI pipeline. - [Run PHP Composer & NPM scripts then deploy them to a staging server](examples/deployment/composer-npm-deploy.md) - [Analyze code quality with the Code Climate CLI](examples/code_climate.md) - **Articles** - - [How to test and deploy Laravel/PHP applications with GitLab CI/CD and Envoy](../articles/test_and_deploy_laravel_apps_with_gitlab_ci_and_envoy/index.md) + - [How to test and deploy Laravel/PHP applications with GitLab CI/CD and Envoy](../articles/laravel_with_gitlab_and_envoy/index.md) - [How to deploy Maven projects to Artifactory with GitLab CI/CD](../articles/artifactory_and_gitlab/index.md) - [Automated Debian packaging](https://about.gitlab.com/2016/10/12/automated-debian-package-build-with-gitlab-ci/) - [Spring boot application with GitLab CI and Kubernetes](https://about.gitlab.com/2016/12/14/continuous-delivery-of-a-spring-boot-application-with-gitlab-ci-and-kubernetes/) -- cgit v1.2.1 From af112c55e54874a37e780de6723c64e9be61b6e8 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Thu, 24 Aug 2017 01:07:35 +0900 Subject: Add doc --- doc/ci/runners/README.md | 19 +++++++++++++++++++ doc/ci/runners/img/protected_runners_check_box.png | Bin 0 -> 8584 bytes doc/ci/runners/img/specific_runners_edit_icon.png | Bin 0 -> 1414 bytes 3 files changed, 19 insertions(+) create mode 100644 doc/ci/runners/img/protected_runners_check_box.png create mode 100644 doc/ci/runners/img/specific_runners_edit_icon.png (limited to 'doc/ci') diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index 76d746155eb..e5750ee6896 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -107,6 +107,23 @@ To lock/unlock a Runner: 1. Check the **Lock to current projects** option 1. Click **Save changes** for the changes to take effect +## Protected runners + +>**Notes:** +This feature requires GitLab 10.0 or higher. + +You can protect runners from revealing sensitive information. +Whenever a runner is protected, the runner picks only jobs created on +[protected branches] or [protected tags], and ignore other jobs. + +To protect/unprotect runners: + +1. Visit your project's **Settings ➔ Pipelines** +1. Find a runner you want to protect/unprotect and make sure it's enabled +1. Click a pencil button ![specific runners edit icon](img/specific_runners_edit_icon.png) resides runner name +1. Check the **Protected** option +1. Click **Save changes** for the changes to take effect + ## How shared Runners pick jobs Shared Runners abide to a process queue we call fair usage. The fair usage @@ -218,3 +235,5 @@ We're always looking for contributions that can mitigate these [install]: http://docs.gitlab.com/runner/install/ [fifo]: https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics) [register]: http://docs.gitlab.com/runner/register/ +[protected branches]: ../../user/project/protected_branches.md +[protected tags]: ../../user/project/protected_tags.md diff --git a/doc/ci/runners/img/protected_runners_check_box.png b/doc/ci/runners/img/protected_runners_check_box.png new file mode 100644 index 00000000000..fb58498c7ce Binary files /dev/null and b/doc/ci/runners/img/protected_runners_check_box.png differ diff --git a/doc/ci/runners/img/specific_runners_edit_icon.png b/doc/ci/runners/img/specific_runners_edit_icon.png new file mode 100644 index 00000000000..e83cf6e3858 Binary files /dev/null and b/doc/ci/runners/img/specific_runners_edit_icon.png differ -- cgit v1.2.1 From 1f114df25ac3f5336316b09dc3ef65da03373318 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Fri, 25 Aug 2017 17:48:33 +0900 Subject: Fix doc --- doc/ci/runners/README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/ci') diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index e5750ee6896..01198744c19 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -124,6 +124,8 @@ To protect/unprotect runners: 1. Check the **Protected** option 1. Click **Save changes** for the changes to take effect +![specific runners edit icon](img/protected_runners_check_box.png) + ## How shared Runners pick jobs Shared Runners abide to a process queue we call fair usage. The fair usage -- cgit v1.2.1 From 6fbb3ce6e93b8dfba795d4542fcb5602c4c82eaf Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Mon, 28 Aug 2017 18:19:45 +0900 Subject: Fix doc --- doc/ci/runners/README.md | 19 ++++++++++--------- doc/ci/runners/img/specific_runners_edit_icon.png | Bin 1414 -> 0 bytes 2 files changed, 10 insertions(+), 9 deletions(-) delete mode 100644 doc/ci/runners/img/specific_runners_edit_icon.png (limited to 'doc/ci') diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index 01198744c19..4ccf1b56771 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -107,24 +107,25 @@ To lock/unlock a Runner: 1. Check the **Lock to current projects** option 1. Click **Save changes** for the changes to take effect -## Protected runners +## Protected Runners >**Notes:** -This feature requires GitLab 10.0 or higher. +[Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/13194) +in GitLab 10.0. -You can protect runners from revealing sensitive information. -Whenever a runner is protected, the runner picks only jobs created on -[protected branches] or [protected tags], and ignore other jobs. +You can protect Runners from revealing sensitive information. +Whenever a Runner is protected, the Runner picks only jobs created on +[protected branches] or [protected tags], and ignores other jobs. -To protect/unprotect runners: +To protect/unprotect Runners: 1. Visit your project's **Settings ➔ Pipelines** -1. Find a runner you want to protect/unprotect and make sure it's enabled -1. Click a pencil button ![specific runners edit icon](img/specific_runners_edit_icon.png) resides runner name +1. Find a Runner you want to protect/unprotect and make sure it's enabled +1. Click the pencil button besides the Runner name 1. Check the **Protected** option 1. Click **Save changes** for the changes to take effect -![specific runners edit icon](img/protected_runners_check_box.png) +![specific Runners edit icon](img/protected_runners_check_box.png) ## How shared Runners pick jobs diff --git a/doc/ci/runners/img/specific_runners_edit_icon.png b/doc/ci/runners/img/specific_runners_edit_icon.png deleted file mode 100644 index e83cf6e3858..00000000000 Binary files a/doc/ci/runners/img/specific_runners_edit_icon.png and /dev/null differ -- cgit v1.2.1