Commit 4c78d44a authored by Marcel Amirault's avatar Marcel Amirault Committed by Andrew Fontaine

Improve settings UI text for Required pipeline configuration

parent bf020294
...@@ -191,30 +191,32 @@ This feature is being re-evaluated in favor of a different ...@@ -191,30 +191,32 @@ This feature is being re-evaluated in favor of a different
We recommend that users who haven't yet implemented this feature wait for We recommend that users who haven't yet implemented this feature wait for
the new solution. the new solution.
GitLab administrators can force a pipeline configuration to run on every You can set a [CI/CD template](../../../ci/examples/README.md#cicd-templates)
pipeline. as a required pipeline configuration for all projects on a GitLab instance. You can
use a template from:
The configuration applies to all pipelines for a GitLab instance and is - The default CI/CD templates.
sourced from: - A custom template stored in an [instance template repository](instance_template_repository.md).
- The [instance template repository](instance_template_repository.md). NOTE:
- GitLab-supplied configuration. When you use a configuration defined in an instance template repository,
nested [`include:`](../../../ci/yaml/README.md#include) keywords
(including `include:file`, `include:local`, `include:remote`, and `include:template`)
[do not work](https://gitlab.com/gitlab-org/gitlab/-/issues/35345).
NOTE: The project CI/CD configuration merges into the required pipeline configuration when
When you use a configuration defined in an instance template repository, a pipeline runs. The merged configuration is the same as if the required pipeline configuration
nested [`include:`](../../../ci/yaml/README.md#include) keywords added the project configuration with the [`include` keyword](../../../ci/yaml/README.md#include).
(including `include:file`, `include:local`, `include:remote`, and `include:template`) To view a project's full merged configuration, [View the merged YAML](../../../ci/pipeline_editor/index.md#view-expanded-configuration)
[do not work](https://gitlab.com/gitlab-org/gitlab/-/issues/35345). in the pipeline editor.
To set required pipeline configuration: To select a CI/CD template for the required pipeline configuration:
1. Go to **Admin Area > Settings > CI/CD**. 1. Go to **Admin Area > Settings > CI/CD**.
1. Expand the **Required pipeline configuration** section. 1. Expand the **Required pipeline configuration** section.
1. Select the required configuration from the provided dropdown. 1. Select a CI/CD template from the dropdown.
1. Click **Save changes**. 1. Click **Save changes**.
![Required pipeline](img/admin_required_pipeline.png)
## Package Registry configuration ## Package Registry configuration
### npm Forwarding **(PREMIUM SELF)** ### npm Forwarding **(PREMIUM SELF)**
......
...@@ -7,19 +7,19 @@ ...@@ -7,19 +7,19 @@
%button.btn.gl-button.btn-default.js-settings-toggle{ type: 'button' } %button.btn.gl-button.btn-default.js-settings-toggle{ type: 'button' }
= expanded ? _('Collapse') : _('Expand') = expanded ? _('Collapse') : _('Expand')
%p %p
- config_link_start = '<a href="%{url}">'.html_safe % { url: help_page_path('ci/yaml/README') } - config_link_start = '<a href="%{url}">'.html_safe % { url: help_page_path('user/admin_area/settings/continuous_integration', anchor: 'required-pipeline-configuration') }
= s_('AdminSettings|Set an instance-wide auto included %{link_start}pipeline configuration%{link_end}. This pipeline configuration will be run after the project\'s own configuration.').html_safe % { link_start: config_link_start, link_end: '</a>'.html_safe } = s_('AdminSettings|Set a CI/CD template as the required pipeline configuration for all projects in the instance. Project CI/CD configuration merges into the required pipeline configuration when the pipeline runs. %{link_start}What is a required pipeline configuration?%{link_end}').html_safe % { link_start: config_link_start, link_end: '</a>'.html_safe }
.settings-content .settings-content
%p %p
- instance_link_start = '<a href="%{url}">'.html_safe % { url: help_page_path('user/admin_area/settings/instance_template_repository') } - instance_link_start = '<a href="%{url}">'.html_safe % { url: help_page_path('user/admin_area/settings/instance_template_repository') }
= s_('AdminSettings|The required pipeline configuration can be selected from the %{code_start}gitlab-ci%{code_end} directory inside of the configured %{link_start}instance template repository%{link_end} or from GitLab provided configurations.').html_safe % { code_start: '<code>'.html_safe, code_end: '</code>'.html_safe, link_start: instance_link_start, link_end: '</a>'.html_safe } = s_('AdminSettings|The template for the required pipeline configuration can be one of the GitLab-provided templates, or a custom template added to an instance template repository. %{link_start}How do I create an instance template repository?%{link_end}').html_safe % { code_start: '<code>'.html_safe, code_end: '</code>'.html_safe, link_start: instance_link_start, link_end: '</a>'.html_safe }
= form_for @application_setting, url: ci_cd_admin_application_settings_path(anchor: 'js-required-pipeline-settings'), html: { class: 'fieldset-form' } do |f| = form_for @application_setting, url: ci_cd_admin_application_settings_path(anchor: 'js-required-pipeline-settings'), html: { class: 'fieldset-form' } do |f|
= form_errors(@application_setting) = form_errors(@application_setting)
%fieldset %fieldset
.form-group .form-group
= f.label :required_instance_ci_template, s_('AdminSettings|Select a pipeline configuration file'), class: 'text-muted' = f.label :required_instance_ci_template, s_('AdminSettings|Select a CI/CD template'), class: 'text-muted'
= dropdown_tag(s_('AdminSettings|No required pipeline'), options: { toggle_class: 'js-ci-template-dropdown dropdown-select', title: s_('AdminSettings|Select a template'), filter: true, placeholder: _("Filter"), data: { data: gitlab_ci_ymls(nil) } } ) = dropdown_tag(s_('AdminSettings|No required pipeline'), options: { toggle_class: 'js-ci-template-dropdown dropdown-select', title: s_('AdminSettings|Select a CI/CD template'), filter: true, placeholder: _("Filter"), data: { data: gitlab_ci_ymls(nil) } } )
= f.text_field :required_instance_ci_template, value: @application_setting.required_instance_ci_template, id: 'required_instance_ci_template_name', class: 'hidden' = f.text_field :required_instance_ci_template, value: @application_setting.required_instance_ci_template, id: 'required_instance_ci_template_name', class: 'hidden'
= f.submit _('Save changes'), class: "gl-button btn btn-confirm" = f.submit _('Save changes'), class: "gl-button btn btn-confirm"
...@@ -2368,10 +2368,7 @@ msgstr "" ...@@ -2368,10 +2368,7 @@ msgstr ""
msgid "AdminSettings|See affected service templates" msgid "AdminSettings|See affected service templates"
msgstr "" msgstr ""
msgid "AdminSettings|Select a pipeline configuration file" msgid "AdminSettings|Select a CI/CD template"
msgstr ""
msgid "AdminSettings|Select a template"
msgstr "" msgstr ""
msgid "AdminSettings|Service template allows you to set default values for integrations" msgid "AdminSettings|Service template allows you to set default values for integrations"
...@@ -2383,7 +2380,7 @@ msgstr "" ...@@ -2383,7 +2380,7 @@ msgstr ""
msgid "AdminSettings|Session duration for Git operations when 2FA is enabled (minutes)" msgid "AdminSettings|Session duration for Git operations when 2FA is enabled (minutes)"
msgstr "" msgstr ""
msgid "AdminSettings|Set an instance-wide auto included %{link_start}pipeline configuration%{link_end}. This pipeline configuration will be run after the project's own configuration." msgid "AdminSettings|Set a CI/CD template as the required pipeline configuration for all projects in the instance. Project CI/CD configuration merges into the required pipeline configuration when the pipeline runs. %{link_start}What is a required pipeline configuration?%{link_end}"
msgstr "" msgstr ""
msgid "AdminSettings|Specify a domain to use by default for every project's Auto Review Apps and Auto Deploy stages." msgid "AdminSettings|Specify a domain to use by default for every project's Auto Review Apps and Auto Deploy stages."
...@@ -2392,7 +2389,7 @@ msgstr "" ...@@ -2392,7 +2389,7 @@ msgstr ""
msgid "AdminSettings|The latest artifacts for all jobs in the most recent successful pipelines in each project are stored and do not expire." msgid "AdminSettings|The latest artifacts for all jobs in the most recent successful pipelines in each project are stored and do not expire."
msgstr "" msgstr ""
msgid "AdminSettings|The required pipeline configuration can be selected from the %{code_start}gitlab-ci%{code_end} directory inside of the configured %{link_start}instance template repository%{link_end} or from GitLab provided configurations." msgid "AdminSettings|The template for the required pipeline configuration can be one of the GitLab-provided templates, or a custom template added to an instance template repository. %{link_start}How do I create an instance template repository?%{link_end}"
msgstr "" msgstr ""
msgid "AdminSettings|When creating a new environment variable it will be protected by default." msgid "AdminSettings|When creating a new environment variable it will be protected by default."
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment