feat: adds codespell action to ensure correct spelling (#259)

* feat: adds codespell action to ensure correct spelling

Signed-off-by: ChrisJBurns <[email protected]>

* bumps chart version

Signed-off-by: ChrisJBurns <[email protected]>

* merge conflicts

Signed-off-by: ChrisJBurns <[email protected]>

* adds codespell action

Signed-off-by: ChrisJBurns <[email protected]>

* bumps chart

Signed-off-by: ChrisJBurns <[email protected]>

---------

Signed-off-by: ChrisJBurns <[email protected]>
Signed-off-by: Chris Burns <[email protected]>

Author: ChrisJBurns

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = NotIn,notin

.github/workflows/spellcheck.yaml

@@ -0,0 +1,18 @@
+name: Codespell
+
+on:
+  pull_request:
+
+jobs:
+  codespell:
+    name: Codespell
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+          skip: .git
+          check_filenames: true
+          check_hidden: true

.pre-commit-config.yaml

@@ -18,3 +18,8 @@ repos:
         additional_dependencies: [jsonref]
         language: python
         types_or: [yaml, json]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+    - id: codespell

charts/backstage/Chart.yaml

@@ -38,4 +38,4 @@ sources:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.5.0
+version: 2.5.1

charts/backstage/README.md

@@ -2,7 +2,7 @@
 # Backstage Helm Chart
 
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/backstage)](https://artifacthub.io/packages/search?repo=backstage)
-![Version: 2.5.0](https://img.shields.io/badge/Version-2.5.0-informational?style=flat-square)
+![Version: 2.5.1](https://img.shields.io/badge/Version-2.5.1-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A Helm chart for deploying a Backstage application
@@ -181,7 +181,7 @@ Kubernetes: `>= 1.19.0-0`
 | metrics.serviceMonitor.interval | ServiceMonitor scrape interval | string | `nil` |
 | metrics.serviceMonitor.labels | Additional ServiceMonitor labels | object | `{}` |
 | metrics.serviceMonitor.path | ServiceMonitor endpoint path <br /> Note that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the [Prometheus metrics tutorial](https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md). | string | `"/metrics"` |
-| metrics.serviceMonitor.port | ServiceMonitor endpoint port <br /> The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitely specificed. OpenTelemetry's default port is 9464. | string | `"http-backend"` |
+| metrics.serviceMonitor.port | ServiceMonitor endpoint port <br /> The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitly specified. OpenTelemetry's default port is 9464. | string | `"http-backend"` |
 | nameOverride | String to partially override common.names.fullname | string | `""` |
 | networkPolicy.egressRules.customRules | Additional custom egress rules | list | `[]` |
 | networkPolicy.egressRules.denyConnectionsToExternal | Deny external connections. Should not be enabled when working with an external database. | bool | `false` |

charts/backstage/values.schema.json

@@ -6473,7 +6473,7 @@
                                 }
                             ],
                             "default": "http-backend",
-                            "description": "The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitely specificed. OpenTelemetry's default port is 9464.",
+                            "description": "The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitly specified. OpenTelemetry's default port is 9464.",
                             "title": "ServiceMonitor endpoint port"
                         }
                     },

charts/backstage/values.schema.tmpl.json

@@ -935,7 +935,7 @@
                         },
                         "port": {
                             "default": "http-backend",
-                            "description": "The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitely specificed. OpenTelemetry's default port is 9464.",
+                            "description": "The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitly specified. OpenTelemetry's default port is 9464.",
                             "title": "ServiceMonitor endpoint port",
                             "anyOf": [
                                 {

charts/backstage/values.yaml

@@ -486,5 +486,5 @@ metrics:
     path: /metrics
 
     # -- ServiceMonitor endpoint port
-    # <br /> The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitely specificed. OpenTelemetry's default port is 9464.
+    # <br /> The port where the metrics are exposed. If using OpenTelemetry as [documented here](https://backstage.io/docs/tutorials/setup-opentelemetry/), then the port needs to be explicitly specified. OpenTelemetry's default port is 9464.
     port: http-backend