From d7c32c5870ff7122122d0fc75ed8a04a0818251e Mon Sep 17 00:00:00 2001 From: Lin Jen-Shin Date: Tue, 4 Jul 2017 02:00:50 +0800 Subject: [PATCH] Fix various descriptions given the feedback --- app/views/projects/pipelines_settings/_show.html.haml | 2 +- .../unreleased/32815--Add-Custom-CI-Config-Path.yml | 2 +- doc/api/projects.md | 8 ++++---- doc/ci/variables/README.md | 2 +- lib/api/projects.rb | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/app/views/projects/pipelines_settings/_show.html.haml b/app/views/projects/pipelines_settings/_show.html.haml index 4b3efd12e08..c9c8bd2610b 100644 --- a/app/views/projects/pipelines_settings/_show.html.haml +++ b/app/views/projects/pipelines_settings/_show.html.haml @@ -50,7 +50,7 @@ = f.label :ci_config_file, 'Custom CI config file', class: 'label-light' = f.text_field :ci_config_file, class: 'form-control', placeholder: '.gitlab-ci.yml' %p.help-block - The path to CI config file. Default to .gitlab-ci.yml + The path to CI config file. Defaults to .gitlab-ci.yml = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'custom-ci-config-file'), target: '_blank' %hr diff --git a/changelogs/unreleased/32815--Add-Custom-CI-Config-Path.yml b/changelogs/unreleased/32815--Add-Custom-CI-Config-Path.yml index eff41f62df4..7784d7d0ce0 100644 --- a/changelogs/unreleased/32815--Add-Custom-CI-Config-Path.yml +++ b/changelogs/unreleased/32815--Add-Custom-CI-Config-Path.yml @@ -1,4 +1,4 @@ --- -title: Allow customize CI config path Keith Pope +title: Allow customize CI config path merge_request: 12509 author: Keith Pope diff --git a/doc/api/projects.md b/doc/api/projects.md index 7565f18e907..7e626f54cda 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -336,7 +336,7 @@ Parameters: | `snippets_enabled` | boolean | no | Enable snippets for this project | | `container_registry_enabled` | boolean | no | Enable container registry for this project | | `shared_runners_enabled` | boolean | no | Enable shared runners for this project | -| `visibility` | String | no | See [project visibility level](#project-visibility-level) | +| `visibility` | string | no | See [project visibility level](#project-visibility-level) | | `import_url` | string | no | URL to import repository from | | `public_jobs` | boolean | no | If `true`, jobs can be viewed by non-project-members | | `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs | @@ -346,7 +346,7 @@ Parameters: | `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project | | `avatar` | mixed | no | Image file for avatar of the project | | `printing_merge_request_link_enabled` | boolean | no | Show link to create/view merge request when pushing from the command line | -| `ci_config_file` | boolean | no | The path to CI config file | +| `ci_config_file` | string | no | The path to CI config file | ### Create project for user @@ -383,7 +383,7 @@ Parameters: | `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project | | `avatar` | mixed | no | Image file for avatar of the project | | `printing_merge_request_link_enabled` | boolean | no | Show link to create/view merge request when pushing from the command line | -| `ci_config_file` | boolean | no | The path to CI config file | +| `ci_config_file` | string | no | The path to CI config file | ### Edit project @@ -418,7 +418,7 @@ Parameters: | `request_access_enabled` | boolean | no | Allow users to request member access | | `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project | | `avatar` | mixed | no | Image file for avatar of the project | -| `ci_config_file` | boolean | no | The path to CI config file | +| `ci_config_file` | string | no | The path to CI config file | ### Fork project diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 82c4ea38aa4..06bb90fa2e8 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -40,7 +40,7 @@ future GitLab releases.** | **CI_COMMIT_REF_SLUG** | 9.0 | all | `$CI_COMMIT_REF_NAME` lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-`. Use in URLs and domain names. | | **CI_COMMIT_SHA** | 9.0 | all | The commit revision for which project is built | | **CI_COMMIT_TAG** | 9.0 | 0.5 | The commit tag name. Present only when building tags. | -| **CI_CONFIG_PATH** | 9.4 | 0.5 | The path to CI config file. Default to `.gitlab-ci.yml` | +| **CI_CONFIG_PATH** | 9.4 | 0.5 | The path to CI config file. Defaults to `.gitlab-ci.yml` | | **CI_DEBUG_TRACE** | all | 1.7 | Whether [debug tracing](#debug-tracing) is enabled | | **CI_ENVIRONMENT_NAME** | 8.15 | all | The name of the environment for this job | | **CI_ENVIRONMENT_SLUG** | 8.15 | all | A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, etc. | diff --git a/lib/api/projects.rb b/lib/api/projects.rb index a781869fc19..efd133d81b3 100644 --- a/lib/api/projects.rb +++ b/lib/api/projects.rb @@ -10,7 +10,7 @@ module API helpers do params :optional_params_ce do optional :description, type: String, desc: 'The description of the project' - optional :ci_config_file, type: String, desc: 'The path to CI config file. Default to `.gitlab-ci.yml`' + optional :ci_config_file, type: String, desc: 'The path to CI config file. Defaults to `.gitlab-ci.yml`' optional :issues_enabled, type: Boolean, desc: 'Flag indication if the issue tracker is enabled' optional :merge_requests_enabled, type: Boolean, desc: 'Flag indication if merge requests are enabled' optional :wiki_enabled, type: Boolean, desc: 'Flag indication if the wiki is enabled'