From 1acb4c1ec8aabc962ade9bf3c82f4771cb7b09e4 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Tue, 7 May 2024 16:34:19 +0200
Subject: [PATCH 1/7] Protected packages: Add help text for name pattern input

- Add documentation for wildcard usage for package name pattern

Changelog: other
---
 .../packages_protection_rule_form.vue         | 34 ++++++++++++++++++-
 .../package_protection_rules.md               | 22 ++++++++++++
 locale/gitlab.pot                             |  3 ++
 3 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
index ef5e4449ea5703..a51721160e6e7e 100644
--- a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
+++ b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
@@ -1,5 +1,16 @@
 <script>
-import { GlAlert, GlButton, GlFormGroup, GlForm, GlFormInput, GlFormSelect } from '@gitlab/ui';
+import {
+  GlAlert,
+  GlButton,
+  GlFormGroup,
+  GlForm,
+  GlFormInput,
+  GlFormSelect,
+  GlFormText,
+  GlLink,
+  GlSprintf,
+} from '@gitlab/ui';
+import { helpPagePath } from '~/helpers/help_page_helper';
 import createPackagesProtectionRuleMutation from '~/packages_and_registries/settings/project/graphql/mutations/create_packages_protection_rule.mutation.graphql';
 import { s__, __ } from '~/locale';
 
@@ -20,11 +31,20 @@ export default {
     GlFormGroup,
     GlAlert,
     GlForm,
+    GlFormText,
+    GlLink,
+    GlSprintf,
   },
   inject: ['projectPath'],
   i18n: {
     PACKAGES_PROTECTION_RULES_SAVED_SUCCESS_MESSAGE,
     PACKAGES_PROTECTION_RULES_SAVED_ERROR_MESSAGE,
+    packageNamePatternInputHelpText: s__(
+      'PackageRegistry|%{wildcardLinkStart}Wildcards%{wildcardLinkEnd} such as `@my-scope/my-package-*` are supported.',
+    ),
+    packageNamePatternInputHelpTextWildcardLinkPath: helpPagePath(
+      'user/packages/package_registry/package_protection_rules.md',
+    ),
   },
   data() {
     return {
@@ -132,6 +152,18 @@ export default {
           required
           :disabled="isFieldDisabled"
         />
+        <gl-form-text>
+          <gl-sprintf :message="$options.i18n.packageNamePatternInputHelpText">
+            <template #wildcardLink="{ content }">
+              <gl-link
+                :href="$options.i18n.packageNamePatternInputHelpTextWildcardLinkPath"
+                target="_blank"
+              >
+                {{ content }}
+              </gl-link>
+            </template>
+          </gl-sprintf>
+        </gl-form-text>
       </gl-form-group>
 
       <gl-form-group
diff --git a/doc/user/packages/package_registry/package_protection_rules.md b/doc/user/packages/package_registry/package_protection_rules.md
index d724ebbe331649..3beb87af3180a6 100644
--- a/doc/user/packages/package_registry/package_protection_rules.md
+++ b/doc/user/packages/package_registry/package_protection_rules.md
@@ -52,6 +52,28 @@ To protect a package:
 
 The package protection rule is created, and appears in the settings.
 
+## Protect multiple packages with wildcard name pattern
+
+When using wildcards for the package name pattern, multiple rules can apply to a single branch. If more than one rule applies to a branch, the most permissive rule controls how the branch behaves. For merge controls to work properly, set Allowed to push and merge to a broader set of users than Allowed to merge.
+
+Prerequisites:
+
+- You must have at least the Maintainer role.
+
+To protect multiple packages at the same time:
+
+1. In the text input **Name pattern**, type the package name and a wildcard. Package names and wildcards are case-sensitive. For example:
+   | Package name pattern with wildcard | Matching packages                                      |
+   |------------------------------------|--------------------------------------------------------|
+   | `@group/package-*`        | `@group/package-prod`, `@group/package-prod-sha123456789` |
+   | `@group/*package`         | `@group/package`, `@group/prod-package`, `@group/prod-sha123456789-package` |
+   | `@group/*package*`        | `@group/package`, `@group/prod-sha123456789-package-v1` |
+
+1. From the **Push protected up to access level** list, select a role that max role that can push packages with this package name.
+1. Select **Protect**.
+
+The package protection rule displays in the list of protected packages.
+
 ## Delete a package protection rule and unprotect a package
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140483) in GitLab 16.10.
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index 26430ec82a1036..bc8c26d24e24b8 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -36667,6 +36667,9 @@ msgstr ""
 msgid "PackageRegistry|%{name} version %{version} was first created %{datetime}"
 msgstr ""
 
+msgid "PackageRegistry|%{wildcardLinkStart}Wildcards%{wildcardLinkEnd} such as `@my-scope/my-package-*` are supported."
+msgstr ""
+
 msgid "PackageRegistry|A protection rule exists for this package."
 msgstr ""
 
-- 
GitLab


From 5a2648b49d469fcfe973414564eb9a301de18b29 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Sat, 25 May 2024 07:44:16 +0200
Subject: [PATCH 2/7] refactor: Apply suggestion from @seggenberger, @kpalchyk

- Use component HelpPageLink, see
  https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152221#note_1917319880
- Use designated slot for form group description, see
  https://gitlab.com/gitlab-org/gitlab/-/merge_requests/152221#note_1919963409
---
 .../packages_protection_rule_form.vue         | 21 +++++++------------
 1 file changed, 7 insertions(+), 14 deletions(-)

diff --git a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
index a51721160e6e7e..b6d5da04f7d86c 100644
--- a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
+++ b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
@@ -6,11 +6,9 @@ import {
   GlForm,
   GlFormInput,
   GlFormSelect,
-  GlFormText,
-  GlLink,
   GlSprintf,
 } from '@gitlab/ui';
-import { helpPagePath } from '~/helpers/help_page_helper';
+import HelpPageLink from '~/vue_shared/components/help_page_link/help_page_link.vue';
 import createPackagesProtectionRuleMutation from '~/packages_and_registries/settings/project/graphql/mutations/create_packages_protection_rule.mutation.graphql';
 import { s__, __ } from '~/locale';
 
@@ -31,9 +29,8 @@ export default {
     GlFormGroup,
     GlAlert,
     GlForm,
-    GlFormText,
-    GlLink,
     GlSprintf,
+    HelpPageLink,
   },
   inject: ['projectPath'],
   i18n: {
@@ -42,9 +39,6 @@ export default {
     packageNamePatternInputHelpText: s__(
       'PackageRegistry|%{wildcardLinkStart}Wildcards%{wildcardLinkEnd} such as `@my-scope/my-package-*` are supported.',
     ),
-    packageNamePatternInputHelpTextWildcardLinkPath: helpPagePath(
-      'user/packages/package_registry/package_protection_rules.md',
-    ),
   },
   data() {
     return {
@@ -152,18 +146,17 @@ export default {
           required
           :disabled="isFieldDisabled"
         />
-        <gl-form-text>
+        <template #description>
           <gl-sprintf :message="$options.i18n.packageNamePatternInputHelpText">
             <template #wildcardLink="{ content }">
-              <gl-link
-                :href="$options.i18n.packageNamePatternInputHelpTextWildcardLinkPath"
+              <help-page-link
+                href="user/packages/package_registry/package_protection_rules.md"
                 target="_blank"
+                >{{ content }}</help-page-link
               >
-                {{ content }}
-              </gl-link>
             </template>
           </gl-sprintf>
-        </gl-form-text>
+        </template>
       </gl-form-group>
 
       <gl-form-group
-- 
GitLab


From 7560b1df4475878fb3365747e5ba11de95d5bd91 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Sat, 25 May 2024 07:58:28 +0200
Subject: [PATCH 3/7] docs: Extend help page regarding protected
 package_registry

- Add helpful information about how to protect multiple packages
  with a wildcard name pattern
---
 .../package_registry/package_protection_rules.md   | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/doc/user/packages/package_registry/package_protection_rules.md b/doc/user/packages/package_registry/package_protection_rules.md
index 3beb87af3180a6..12f50c9bc44295 100644
--- a/doc/user/packages/package_registry/package_protection_rules.md
+++ b/doc/user/packages/package_registry/package_protection_rules.md
@@ -54,7 +54,9 @@ The package protection rule is created, and appears in the settings.
 
 ## Protect multiple packages with wildcard name pattern
 
-When using wildcards for the package name pattern, multiple rules can apply to a single branch. If more than one rule applies to a branch, the most permissive rule controls how the branch behaves. For merge controls to work properly, set Allowed to push and merge to a broader set of users than Allowed to merge.
+When using wildcards for the package name pattern, it is possible to protect several packages at once. This is helpful when temporary package builds need to be protected as well, e.g. as part of the ci pipeline.
+
+When using wildcards for the package name pattern, multiple protection rules can apply to different packages in the project's package registry. If at least one protection rule applies to the package then the package is protected, regardless if more than one protection rule applies to the package.
 
 Prerequisites:
 
@@ -63,11 +65,11 @@ Prerequisites:
 To protect multiple packages at the same time:
 
 1. In the text input **Name pattern**, type the package name and a wildcard. Package names and wildcards are case-sensitive. For example:
-   | Package name pattern with wildcard | Matching packages                                      |
-   |------------------------------------|--------------------------------------------------------|
-   | `@group/package-*`        | `@group/package-prod`, `@group/package-prod-sha123456789` |
-   | `@group/*package`         | `@group/package`, `@group/prod-package`, `@group/prod-sha123456789-package` |
-   | `@group/*package*`        | `@group/package`, `@group/prod-sha123456789-package-v1` |
+   | Package name pattern with wildcard | Matching packages                                                           |
+   |------------------------------------|-----------------------------------------------------------------------------|
+   | `@group/package-*`                 | `@group/package-prod`, `@group/package-prod-sha123456789`                   |
+   | `@group/*package`                  | `@group/package`, `@group/prod-package`, `@group/prod-sha123456789-package` |
+   | `@group/*package*`                 | `@group/package`, `@group/prod-sha123456789-package-v1`                     |
 
 1. From the **Push protected up to access level** list, select a role that max role that can push packages with this package name.
 1. Select **Protect**.
-- 
GitLab


From 51447ad08fec9e6b57cb27856b92b2684c91d507 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Tue, 28 May 2024 10:06:48 +0000
Subject: [PATCH 4/7] refactor: Apply suggestion from @dmishunov

---
 .../project/components/packages_protection_rule_form.vue      | 4 ++--
 locale/gitlab.pot                                             | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
index b6d5da04f7d86c..0e6dff1effad8c 100644
--- a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
+++ b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
@@ -37,7 +37,7 @@ export default {
     PACKAGES_PROTECTION_RULES_SAVED_SUCCESS_MESSAGE,
     PACKAGES_PROTECTION_RULES_SAVED_ERROR_MESSAGE,
     packageNamePatternInputHelpText: s__(
-      'PackageRegistry|%{wildcardLinkStart}Wildcards%{wildcardLinkEnd} such as `@my-scope/my-package-*` are supported.',
+      'PackageRegistry|%{wildcard-linkStart}Wildcards%{wildcard-linkEnd} such as `@my-scope/my-package-*` are supported.',
     ),
   },
   data() {
@@ -148,7 +148,7 @@ export default {
         />
         <template #description>
           <gl-sprintf :message="$options.i18n.packageNamePatternInputHelpText">
-            <template #wildcardLink="{ content }">
+            <template #wildcard-link="{ content }">
               <help-page-link
                 href="user/packages/package_registry/package_protection_rules.md"
                 target="_blank"
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index bc8c26d24e24b8..8ab9b338df4c20 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -36667,7 +36667,7 @@ msgstr ""
 msgid "PackageRegistry|%{name} version %{version} was first created %{datetime}"
 msgstr ""
 
-msgid "PackageRegistry|%{wildcardLinkStart}Wildcards%{wildcardLinkEnd} such as `@my-scope/my-package-*` are supported."
+msgid "PackageRegistry|%{wildcard-linkStart}Wildcards%{wildcard-linkEnd} such as `@my-scope/my-package-*` are supported."
 msgstr ""
 
 msgid "PackageRegistry|A protection rule exists for this package."
-- 
GitLab


From 44193e0bd5b3bfe05c983b2893b0fb807f32d478 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Wed, 29 May 2024 08:23:44 +0000
Subject: [PATCH 5/7] docs: Apply suggestion from @phillipwells

---
 .../package_protection_rules.md               | 31 +++++++------------
 1 file changed, 11 insertions(+), 20 deletions(-)

diff --git a/doc/user/packages/package_registry/package_protection_rules.md b/doc/user/packages/package_registry/package_protection_rules.md
index 12f50c9bc44295..3a140fd7d5c95b 100644
--- a/doc/user/packages/package_registry/package_protection_rules.md
+++ b/doc/user/packages/package_registry/package_protection_rules.md
@@ -52,30 +52,21 @@ To protect a package:
 
 The package protection rule is created, and appears in the settings.
 
-## Protect multiple packages with wildcard name pattern
+### Protecting multiple packages
 
-When using wildcards for the package name pattern, it is possible to protect several packages at once. This is helpful when temporary package builds need to be protected as well, e.g. as part of the ci pipeline.
+You can use a wildcard to protect multiple packages with the same package protection rule.
+For example, you can protect all the temporary packages built during a CI/CD pipeline.
 
-When using wildcards for the package name pattern, multiple protection rules can apply to different packages in the project's package registry. If at least one protection rule applies to the package then the package is protected, regardless if more than one protection rule applies to the package.
+The following table contains examples of package protection rules that match multiple packages:
 
-Prerequisites:
-
-- You must have at least the Maintainer role.
-
-To protect multiple packages at the same time:
-
-1. In the text input **Name pattern**, type the package name and a wildcard. Package names and wildcards are case-sensitive. For example:
-   | Package name pattern with wildcard | Matching packages                                                           |
-   |------------------------------------|-----------------------------------------------------------------------------|
-   | `@group/package-*`                 | `@group/package-prod`, `@group/package-prod-sha123456789`                   |
-   | `@group/*package`                  | `@group/package`, `@group/prod-package`, `@group/prod-sha123456789-package` |
-   | `@group/*package*`                 | `@group/package`, `@group/prod-sha123456789-package-v1`                     |
-
-1. From the **Push protected up to access level** list, select a role that max role that can push packages with this package name.
-1. Select **Protect**.
-
-The package protection rule displays in the list of protected packages.
+| Package name pattern with wildcard | Matching packages                                                           |
+|------------------------------------|-----------------------------------------------------------------------------|
+| `@group/package-*`                 | `@group/package-prod`, `@group/package-prod-sha123456789`                   |
+| `@group/*package`                  | `@group/package`, `@group/prod-package`, `@group/prod-sha123456789-package` |
+| `@group/*package*`                 | `@group/package`, `@group/prod-sha123456789-package-v1`                     |
 
+It's possible to apply several protection rules to the same package.
+If at least one protection rule applies to the package, the package is protected.
 ## Delete a package protection rule and unprotect a package
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140483) in GitLab 16.10.
-- 
GitLab


From 93cc406f4325b4b2874fe24ad2e335d97796a703 Mon Sep 17 00:00:00 2001
From: Phillip Wells <pwells@gitlab.com>
Date: Wed, 29 May 2024 14:22:21 +0000
Subject: [PATCH 6/7] Make linter happy

---
 doc/user/packages/package_registry/package_protection_rules.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/user/packages/package_registry/package_protection_rules.md b/doc/user/packages/package_registry/package_protection_rules.md
index 3a140fd7d5c95b..4385448662e265 100644
--- a/doc/user/packages/package_registry/package_protection_rules.md
+++ b/doc/user/packages/package_registry/package_protection_rules.md
@@ -67,6 +67,7 @@ The following table contains examples of package protection rules that match mul
 
 It's possible to apply several protection rules to the same package.
 If at least one protection rule applies to the package, the package is protected.
+
 ## Delete a package protection rule and unprotect a package
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140483) in GitLab 16.10.
-- 
GitLab


From 8fb140039b09b87f7569d794f64bb88cfa1a7c64 Mon Sep 17 00:00:00 2001
From: Gerardo Navarro <gerardo@b310.de>
Date: Wed, 29 May 2024 18:48:05 +0200
Subject: [PATCH 7/7] refactor: Fix linting issue for gettext (pot) files

- Fixing failing step in ci pipeline, see https://gitlab.com/gitlab-org/gitlab/-/jobs/6970971758
---
 .../project/components/packages_protection_rule_form.vue      | 4 ++--
 locale/gitlab.pot                                             | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
index 0e6dff1effad8c..42990af8082df9 100644
--- a/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
+++ b/app/assets/javascripts/packages_and_registries/settings/project/components/packages_protection_rule_form.vue
@@ -37,7 +37,7 @@ export default {
     PACKAGES_PROTECTION_RULES_SAVED_SUCCESS_MESSAGE,
     PACKAGES_PROTECTION_RULES_SAVED_ERROR_MESSAGE,
     packageNamePatternInputHelpText: s__(
-      'PackageRegistry|%{wildcard-linkStart}Wildcards%{wildcard-linkEnd} such as `@my-scope/my-package-*` are supported.',
+      'PackageRegistry|%{linkStart}Wildcards%{linkEnd} such as `@my-scope/my-package-*` are supported.',
     ),
   },
   data() {
@@ -148,7 +148,7 @@ export default {
         />
         <template #description>
           <gl-sprintf :message="$options.i18n.packageNamePatternInputHelpText">
-            <template #wildcard-link="{ content }">
+            <template #link="{ content }">
               <help-page-link
                 href="user/packages/package_registry/package_protection_rules.md"
                 target="_blank"
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index 8ab9b338df4c20..6a92a1bf0b60eb 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -36664,10 +36664,10 @@ msgstr ""
 msgid "PackageRegistry|%{count} packages were not published to the registry. Remove these packages and try again."
 msgstr ""
 
-msgid "PackageRegistry|%{name} version %{version} was first created %{datetime}"
+msgid "PackageRegistry|%{linkStart}Wildcards%{linkEnd} such as `@my-scope/my-package-*` are supported."
 msgstr ""
 
-msgid "PackageRegistry|%{wildcard-linkStart}Wildcards%{wildcard-linkEnd} such as `@my-scope/my-package-*` are supported."
+msgid "PackageRegistry|%{name} version %{version} was first created %{datetime}"
 msgstr ""
 
 msgid "PackageRegistry|A protection rule exists for this package."
-- 
GitLab