fix: use correct casing in docs for GitLab provider (#2303)

* fix: use correct casing in docs for GitLab provider

Signed-off-by: Maikel Vlasman <git@maikelvlasman.com>

* chore: update helm tests

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>

---------

Signed-off-by: Maikel Vlasman <git@maikelvlasman.com>
Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
Co-authored-by: Maikel Vlasman <git@maikelvlasman.com>
Co-authored-by: Moritz Johner <beller.moritz@googlemail.com>

apis/externalsecrets/v1alpha1/secretstore_types.go

@@ -70,7 +70,7 @@ type SecretStoreProvider struct {
 	// +optional
 	YandexLockbox *YandexLockboxProvider `json:"yandexlockbox,omitempty"`
 
-	// Gitlab configures this store to sync secrets using Gitlab Variables provider
+	// GitLab configures this store to sync secrets using GitLab Variables provider
 	// +optional
 	Gitlab *GitlabProvider `json:"gitlab,omitempty"`
 

apis/externalsecrets/v1beta1/secretstore_types.go

@@ -93,7 +93,7 @@ type SecretStoreProvider struct {
 	// +optional
 	YandexLockbox *YandexLockboxProvider `json:"yandexlockbox,omitempty"`
 
-	// Gitlab configures this store to sync secrets using Gitlab Variables provider
+	// GitLab configures this store to sync secrets using GitLab Variables provider
 	// +optional
 	Gitlab *GitlabProvider `json:"gitlab,omitempty"`
 

config/crds/bases/external-secrets.io_clustersecretstores.yaml

@@ -627,8 +627,8 @@ spec:
                         type: string
                     type: object
                   gitlab:
-                    description: Gitlab configures this store to sync secrets using
-                      Gitlab Variables provider
+                    description: GitLab configures this store to sync secrets using
+                      GitLab Variables provider
                     properties:
                       auth:
                         description: Auth configures how secret-manager authenticates
@@ -2341,8 +2341,8 @@ spec:
                         type: string
                     type: object
                   gitlab:
-                    description: Gitlab configures this store to sync secrets using
-                      Gitlab Variables provider
+                    description: GitLab configures this store to sync secrets using
+                      GitLab Variables provider
                     properties:
                       auth:
                         description: Auth configures how secret-manager authenticates

config/crds/bases/external-secrets.io_secretstores.yaml

@@ -627,8 +627,8 @@ spec:
                         type: string
                     type: object
                   gitlab:
-                    description: Gitlab configures this store to sync secrets using
-                      Gitlab Variables provider
+                    description: GitLab configures this store to sync secrets using
+                      GitLab Variables provider
                     properties:
                       auth:
                         description: Auth configures how secret-manager authenticates
@@ -2341,8 +2341,8 @@ spec:
                         type: string
                     type: object
                   gitlab:
-                    description: Gitlab configures this store to sync secrets using
-                      Gitlab Variables provider
+                    description: GitLab configures this store to sync secrets using
+                      GitLab Variables provider
                     properties:
                       auth:
                         description: Auth configures how secret-manager authenticates

deploy/charts/external-secrets/tests/__snapshot__/crds_test.yaml.snap

@@ -4,8 +4,7 @@ should match snapshot of default values:
     kind: CustomResourceDefinition
     metadata:
       annotations:
-        controller-gen.kubebuilder.io/version: v0.11.3
-      creationTimestamp: null
+        controller-gen.kubebuilder.io/version: v0.11.4
       name: secretstores.external-secrets.io
     spec:
       conversion:
@@ -477,7 +476,7 @@ should match snapshot of default values:
                               type: string
                           type: object
                         gitlab:
-                          description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                          description: GitLab configures this store to sync secrets using GitLab Variables provider
                           properties:
                             auth:
                               description: Auth configures how secret-manager authenticates with a GitLab instance.
@@ -1723,7 +1722,7 @@ should match snapshot of default values:
                               type: string
                           type: object
                         gitlab:
-                          description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                          description: GitLab configures this store to sync secrets using GitLab Variables provider
                           properties:
                             auth:
                               description: Auth configures how secret-manager authenticates with a GitLab instance.

deploy/crds/bundle.yaml

@@ -920,7 +920,7 @@ spec:
                           type: string
                       type: object
                     gitlab:
-                      description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                      description: GitLab configures this store to sync secrets using GitLab Variables provider
                       properties:
                         auth:
                           description: Auth configures how secret-manager authenticates with a GitLab instance.
@@ -2166,7 +2166,7 @@ spec:
                           type: string
                       type: object
                     gitlab:
-                      description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                      description: GitLab configures this store to sync secrets using GitLab Variables provider
                       properties:
                         auth:
                           description: Auth configures how secret-manager authenticates with a GitLab instance.
@@ -4474,7 +4474,7 @@ spec:
                           type: string
                       type: object
                     gitlab:
-                      description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                      description: GitLab configures this store to sync secrets using GitLab Variables provider
                       properties:
                         auth:
                           description: Auth configures how secret-manager authenticates with a GitLab instance.
@@ -5720,7 +5720,7 @@ spec:
                           type: string
                       type: object
                     gitlab:
-                      description: Gitlab configures this store to sync secrets using Gitlab Variables provider
+                      description: GitLab configures this store to sync secrets using GitLab Variables provider
                       properties:
                         auth:
                           description: Auth configures how secret-manager authenticates with a GitLab instance.

docs/api/spec.md

@@ -4482,7 +4482,7 @@ GitlabProvider
 </td>
 <td>
 <em>(Optional)</em>
-<p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
+<p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
 </td>
 </tr>
 <tr>

docs/introduction/stability-support.md

@@ -40,7 +40,7 @@ The following table describes the stability level of each provider and who's res
 | [IBM Cloud Secrets Manager](https://external-secrets.io/latest/provider/ibm-secrets-manager/)              |  stable   | [@knelasevero](https://github.com/knelasevero) [@sebagomez](https://github.com/sebagomez) [@ricardoptcosta](https://github.com/ricardoptcosta) [@IdanAdar](https://github.com/IdanAdar) |
 | [Kubernetes](https://external-secrets.io/latest/provider/kubernetes)                                       |   beta    |                                                                                                                                 [external-secrets](https://github.com/external-secrets) |
 | [Yandex Lockbox](https://external-secrets.io/latest/provider/yandex-lockbox/)                              |   alpha   |                                                                                     [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) |
-| [Gitlab Variables](https://external-secrets.io/latest/provider/gitlab-variables/)                          |   alpha   |                                                                                                                                                  [@Jabray5](https://github.com/Jabray5) |
+| [GitLab Variables](https://external-secrets.io/latest/provider/gitlab-variables/)                          |   alpha   |                                                                                                                                                  [@Jabray5](https://github.com/Jabray5) |
 | Alibaba Cloud KMS                                                                                          |   alpha   |                                                                                                                                          [@ElsaChelala](https://github.com/ElsaChelala) |
 | [Oracle Vault](https://external-secrets.io/latest/provider/oracle-vault)                                   |   alpha   |                                                                                                 [@KianTigger](https://github.com/KianTigger) [@EladGabay](https://github.com/EladGabay) |
 | [Akeyless](https://external-secrets.io/latest/provider/akeyless)                                           |   alpha   |                                                                                                                                    [@renanaAkeyless](https://github.com/renanaAkeyless) |
@@ -65,7 +65,7 @@ The following table show the support for features across different providers.
 | Kubernetes                |      x       |      x       |          x           |            x            |        x         |             |              x              |
 | IBM Cloud Secrets Manager |              |              |                      |                         |        x         |             |                             |
 | Yandex Lockbox            |              |              |                      |                         |        x         |             |                             |
-| Gitlab Variables          |      x       |      x       |                      |                         |        x         |             |                             |
+| GitLab Variables          |      x       |      x       |                      |                         |        x         |             |                             |
 | Alibaba Cloud KMS         |              |              |                      |                         |        x         |             |                             |
 | Oracle Vault              |              |              |                      |                         |        x         |             |                             |
 | Akeyless                  |      x       |      x       |                      |                         |        x         |             |                             |

docs/provider/gitlab-variables.md

@@ -1,10 +1,9 @@
-## Gitlab Variables
+## GitLab Variables
 
-External Secrets Operator integrates with Gitlab to sync [Gitlab Project Variables API](https://docs.gitlab.com/ee/api/project_level_variables.html) and/or [Gitlab Group Variables API](https://docs.gitlab.com/ee/api/group_level_variables.html) to secrets held on the Kubernetes cluster.
+External Secrets Operator integrates with GitLab to sync [GitLab Project Variables API](https://docs.gitlab.com/ee/api/project_level_variables.html) and/or [GitLab Group Variables API](https://docs.gitlab.com/ee/api/group_level_variables.html) to secrets held on the Kubernetes cluster.
 
-### Configuring Gitlab
-
-The Gitlab API requires an access token, project ID and/or groupIDs.
+### Configuring GitLab
+The GitLab API requires an access token, project ID and/or groupIDs.
 
 To create a new access token, go to your user settings and select 'access tokens'. Give your token a name, expiration date, and select the permissions required (Note 'api' is required).
 
@@ -39,7 +38,7 @@ Your project ID can be found on your project's page.
 
 ### Creating external secret
 
-To sync a Gitlab variable to a secret on the Kubernetes cluster, a `Kind=ExternalSecret` is needed.
+To sync a GitLab variable to a secret on the Kubernetes cluster, a `Kind=ExternalSecret` is needed.
 
 ```yaml
 {% include 'gitlab-external-secret.yaml' %}

docs/spec.md

@@ -4114,7 +4114,7 @@ GitlabProvider
 </td>
 <td>
 <em>(Optional)</em>
-<p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
+<p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
 </td>
 </tr>
 <tr>

e2e/suites/provider/cases/gitlab/gitlab.go

@@ -12,7 +12,7 @@ limitations under the License.
 */
 package gitlab
 
-// TODO - Gitlab only accepts variable names with alphanumeric and '_'
+// TODO - GitLab only accepts variable names with alphanumeric and '_'
 // whereas ESO only accepts names with alphanumeric and '-'.
 // Current workaround is to remove all hyphens and underscores set in e2e/framework/util/util.go
 // and in e2e/suite/common/common.go, but this breaks Azure provider.

hack/api-docs/mkdocs.yml

@@ -93,7 +93,7 @@ nav:
     - Yandex Certificate Manager: provider/yandex-certificate-manager.md
     - Yandex Lockbox: provider/yandex-lockbox.md
     - Alibaba Cloud: provider/alibaba.md
-    - Gitlab Variables: provider/gitlab-variables.md
+    - GitLab Variables: provider/gitlab-variables.md
     - Oracle Vault: provider/oracle-vault.md
     - 1Password Secrets Automation: provider/1password-automation.md
     - Webhook: provider/webhook.md

pkg/provider/gitlab/gitlab.go

@@ -46,7 +46,7 @@ const (
 	errNameNotDefined                         = "'find.name' is mandatory"
 	errEnvironmentIsConstricted               = "'find.tags' is constrained by 'environment_scope' of the store"
 	errTagsOnlyEnvironmentSupported           = "'find.tags' only supports 'environment_scope'"
-	errPathNotImplemented                     = "'find.path' is not implemented in the Gitlab provider"
+	errPathNotImplemented                     = "'find.path' is not implemented in the GitLab provider"
 	errJSONSecretUnmarshal                    = "unable to unmarshal secret: %w"
 )
 
@@ -220,7 +220,7 @@ func (g *gitlabBase) GetSecret(_ context.Context, ref esv1beta1.ExternalSecretDa
 		return nil, fmt.Errorf(errUninitializedGitlabProvider)
 	}
 
-	// Need to replace hyphens with underscores to work with Gitlab API
+	// Need to replace hyphens with underscores to work with GitLab API
 	ref.Key = strings.ReplaceAll(ref.Key, "-", "_")
 	// Retrieves a gitlab variable in the form
 	// {

pkg/provider/gitlab/gitlab_test.go

@@ -477,7 +477,7 @@ func TestGetAllSecrets(t *testing.T) {
 	setUnsupportedFindPath := func(smtc *secretManagerTestCase) {
 		path := "path"
 		smtc.refFind.Path = &path
-		smtc.expectError = "'find.path' is not implemented in the Gitlab provider"
+		smtc.expectError = "'find.path' is not implemented in the GitLab provider"
 	}
 	setUnsupportedFindTag := func(smtc *secretManagerTestCase) {
 		smtc.expectError = "'find.tags' only supports 'environment_scope"

pkg/provider/gitlab/provider.go

@@ -44,7 +44,7 @@ func (g *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
 	return esv1beta1.SecretStoreReadOnly
 }
 
-// Method on Gitlab Provider to set up projectVariablesClient with credentials, populate projectID and environment.
+// Method on GitLab Provider to set up projectVariablesClient with credentials, populate projectID and environment.
 func (g *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.SecretsClient, error) {
 	storeSpec := store.GetSpec()
 	if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Gitlab == nil {
@@ -85,7 +85,7 @@ func (g *gitlabBase) getClient(ctx context.Context, provider *esv1beta1.GitlabPr
 	// ClientOptionFunc from the gitlab package can be mapped with the CRD
 	// in a similar way to extend functionality of the provider
 
-	// Create a new Gitlab Client using credentials and options
+	// Create a new GitLab Client using credentials and options
 	client, err := gitlab.NewClient(string(credentials), opts...)
 	if err != nil {
 		return nil, err