feat: GitHub workflow Codespell (#256)

Signed-off-by: Vara Bonthu <[email protected]>

.github/workflows/codespell.yaml

@@ -0,0 +1,27 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true
+          # When using this Action in other repos, the --skip option below can be removed
+          skip: "*.excalidraw,*.git,*.png,*.jpg,*.svg,go.mod,go.sum"
+        continue-on-error: true # The PR checks will not fail, but the possible spelling issues will still be reported for review and correction

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+# For more information, visit: https://pre-commit.com
+# To run locally:
+# 1. Install pre-commit: pip install pre-commit
+# 2. Run pre-commit checks on all files: pre-commit run --all-files
+
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args: ["--skip=*.excalidraw,*.git,*.png,*.jpg,*.svg,go.sum,go.mod"]

api/v1alpha1/localbuild_types.go

@@ -20,7 +20,7 @@ const (
 )
 
 // ArgoPackageConfigSpec Allows for configuration of the ArgoCD Installation.
-// If no fields are specified then the binary embedded resources will be used to intall ArgoCD.
+// If no fields are specified then the binary embedded resources will be used to install ArgoCD.
 type ArgoPackageConfigSpec struct {
 	// Enabled controls whether to install ArgoCD.
 	Enabled bool `json:"enabled,omitempty"`

examples/basic/README.md

@@ -10,7 +10,7 @@ The [package1 directory](./package1) is an example of a custom package that you
 This configuration instructs idpbuilder to:
 
 1. Create a Gitea repository.
-2. Sync the contents of the [manifests](./package1/manifests) directory to the repostiory.
+2. Sync the contents of the [manifests](./package1/manifests) directory to the repository.
 3. Replace the `spec.Source(s).repoURL` field with the Gitea repository URL.
 
 ### Remote manifests

examples/ref-implementation/README.md

@@ -117,7 +117,7 @@ You can click on the ArgoCD Application name to see more details.
 
 In this example, we will deploy a simple Apache Spark job through Argo Workflows.
 
-Click on the `Create...` button on the left, then select the `Basic Argo Workflow witha Spark Job` template.
+Click on the `Create...` button on the left, then select the `Basic Argo Workflow with a Spark Job` template.
 
 ![img.png](images/backstage-templates-spark.png)
 

examples/terraform-integrations/README.md

@@ -13,6 +13,6 @@ idpbuilder create \
 
 As you see above, this add-on to `idpbuilder` has a dependency to the [reference implementation](../ref-implementation/). This command primarily does the following:
 
-1. Installs `fluxcd` source respository controller as an `argo` application.
+1. Installs `fluxcd` source repository controller as an `argo` application.
 2. Installs `tofu-controller` for managing the lifecycle of terraform deployments from your Kubernetes cluster for operations such as create, delete and update.
 3. Finally, this stack add-on goes together with the work done under [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/). Once the add-on is enabled, the user will need to follow the setup discussed in the [backstage-terraform-integrations](https://github.com/cnoe-io/backstage-terraform-integrations/) repo for the remainder of the configuration, and terraform integrations should work.

pkg/cmd/create/root.go

@@ -160,7 +160,7 @@ func getPackageCustomFile(input string) (v1alpha1.PackageCustomization, error) {
 	// the format should be `<package-name>:<path-to-file>`
 	s := strings.Split(input, ":")
 	if len(s) != 2 {
-		return v1alpha1.PackageCustomization{}, fmt.Errorf("ensure %s is formated as <package-name>:<path-to-file>", input)
+		return v1alpha1.PackageCustomization{}, fmt.Errorf("ensure %s is formatted as <package-name>:<path-to-file>", input)
 	}
 
 	paths, err := helpers.GetAbsFilePaths([]string{s[1]}, false)

pkg/cmd/helpers/validation.go

@@ -24,10 +24,10 @@ func ValidateKubernetesYamlFile(absPath string) error {
 	for i := range n {
 		obj := n[i]
 		if obj.IsNilOrEmpty() {
-			return fmt.Errorf("given file %s contains an invalid kubenretes manifest", absPath)
+			return fmt.Errorf("given file %s contains an invalid kubernetes manifest", absPath)
 		}
 		if obj.GetKind() == "" || obj.GetApiVersion() == "" {
-			return fmt.Errorf("given file %s contains an invalid kubenretes manifest", absPath)
+			return fmt.Errorf("given file %s contains an invalid kubernetes manifest", absPath)
 		}
 	}
 

pkg/controllers/localbuild/argo_test.go

@@ -30,7 +30,7 @@ func TestGetRawInstallResources(t *testing.T) {
 	resourcePrefix := "# UCP ARGO INSTALL RESOURCES\n"
 	checkPrefix := resources[1][0:len(resourcePrefix)]
 	if resourcePrefix != string(checkPrefix) {
-		t.Fatalf("GetRawInstallResources() exptected 1 resource with prefix %q, got %q", resourcePrefix, checkPrefix)
+		t.Fatalf("GetRawInstallResources() expected 1 resource with prefix %q, got %q", resourcePrefix, checkPrefix)
 	}
 }
 

pkg/controllers/resources/idpbuilder.cnoe.io_localbuilds.yaml

@@ -42,7 +42,7 @@ spec:
                   argoPackageConfigs:
                     description: |-
                       ArgoPackageConfigSpec Allows for configuration of the ArgoCD Installation.
-                      If no fields are specified then the binary embedded resources will be used to intall ArgoCD.
+                      If no fields are specified then the binary embedded resources will be used to install ArgoCD.
                     properties:
                       enabled:
                         description: Enabled controls whether to install ArgoCD.

pkg/k8s/client.go

@@ -37,7 +37,7 @@ func EnsureObject(ctx context.Context, kubeClient client.Client, obj client.Obje
 		return err
 	}
 
-	// hacky way to restore the GVK for the object after create corrupts it. didnt dig. not sure why?
+	// hacky way to restore the GVK for the object after create corrupts it. didn't dig. not sure why?
 	obj.GetObjectKind().SetGroupVersionKind(curObj.GroupVersionKind())
 	return nil
 }

pkg/kind/cluster.go

@@ -182,7 +182,7 @@ func (c *Cluster) Reconcile(ctx context.Context, recreate bool) error {
 			}
 
 			if !rightPort {
-				return fmt.Errorf("cant serve port %s. cluster %s is already running on a different port", c.cfg.Port, c.name)
+				return fmt.Errorf("can't serve port %s. cluster %s is already running on a different port", c.cfg.Port, c.name)
 			}
 
 			// reuse if there is no port conflict

pkg/runtime/finch.go

@@ -11,7 +11,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-type Conainer struct {
+type Container struct {
 	NetworkSettings NetworkSettings `json:"NetworkSettings"`
 	State           State           `json:"State"`
 }
@@ -59,7 +59,7 @@ func (f *FinchRuntime) ContainerWithPort(ctx context.Context, name string, port
 		return false, err
 	}
 
-	var containers []Conainer
+	var containers []Container
 	err = json.Unmarshal(stdout.Bytes(), &containers)
 	if err != nil {
 		return false, fmt.Errorf("%v: %s", err, stderr.String())

pkg/runtime/provider.go

@@ -12,6 +12,6 @@ type IRuntime interface {
 	// get runtime name
 	Name() string
 
-	// checks whether the container has the followin
+	// checks whether the container has the following
 	ContainerWithPort(ctx context.Context, name, port string) (bool, error)
 }

pkg/util/util_test.go

@@ -33,7 +33,7 @@ func TestGeneratePassword(t *testing.T) {
 			}
 		}
 		if counts[0] != passwordLength {
-			t.Fatalf("password legnth incorrect")
+			t.Fatalf("password length incorrect")
 		}
 		if counts[1] < numSpecialChars {
 			t.Fatalf("min number of special chars not generated")