Add codespell to CI (#5683)

Closes #5659 

### Summary of the changes in the code

1.  Added the codespell GitHub workflow.
2. Added makefile command which is related the codespell.
3. Added the requirements.txt file which is used for install the
dependency package of Python.

---------

Co-authored-by: Damien Mathieu <[email protected]>
Co-authored-by: Tyler Yahn <[email protected]>

.codespellignore

@@ -0,0 +1,3 @@
+ot
+fo
+

.codespellrc

@@ -0,0 +1,10 @@
+# https://github.com/codespell-project/codespell
+[codespell]
+builtin = clear,rare,informal
+check-filenames =
+check-hidden =
+ignore-words = .codespellignore
+interactive = 1
+skip = .git,go.mod,go.sum,go.work,go.work.sum,semconv,venv,.tools
+uri-ignore-words-list = *
+write =

.github/ISSUE_TEMPLATE/owner.md

@@ -20,7 +20,7 @@ Module: [e.g. go.opentelemetry.io/contrib/zpages]
 
 [member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/community-membership.md#member
 
-### Relvant experience
+### Relevant experience
 
 List any PRs/Issues you have interacted with in this repository for this module.
 

.github/workflows/changelog.yml

@@ -1,6 +1,6 @@
 # This action requires that any PR targeting the main branch should touch at
 # least one CHANGELOG file. If a CHANGELOG entry is not required, or if
-# performing maintance on the Changelog, add either \"[chore]\" to the title of
+# performing maintenance on the Changelog, add either \"[chore]\" to the title of
 # the pull request or add the \"Skip Changelog\" label to disable this action.
 
 name: changelog

.github/workflows/ci.yml

@@ -105,7 +105,7 @@ jobs:
         go-version: ["~1.22.3", "~1.21.10"]
         os: [ubuntu-latest, macos-latest, windows-latest]
         # GitHub Actions does not support arm* architectures on default
-        # runners. It is possible to acomplish this with a self-hosted runner
+        # runners. It is possible to accomplish this with a self-hosted runner
         # if we want to add this in the future:
         # https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
         arch: ["386", amd64]

.github/workflows/codespell.yml

@@ -0,0 +1,14 @@
+name: codespell
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+      - name: Codespell
+        run: make codespell

.gitignore

@@ -2,6 +2,7 @@
 Thumbs.db
 
 .tools/
+venv/
 .idea/
 .vscode/
 *.iml

.golangci.yml

@@ -106,7 +106,7 @@ linters-settings:
       - name: constant-logical-expr
         disabled: false
       # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument
-      # TODO (#2877) reenable linter when it is compatible. https://github.com/golangci/golangci-lint/issues/3280
+      # TODO (#2877) re-enable linter when it is compatible. https://github.com/golangci/golangci-lint/issues/3280
       - name: context-as-argument
         disabled: true
         arguments:

CONTRIBUTING.md

@@ -104,7 +104,7 @@ A pull request is considered ready to merge when the following criteria are meet
 Any Maintainer can merge the pull request once it is ready to merge.
 
 [^1]: The `go.opentelemetry.io/contrib/instrgen` module is exempt from the two approvals and one day requirement.
-  Only one approval is needed to merge a Pull Request for that module and there is no minimum amout of time required for the PR to be open before merging.
+  Only one approval is needed to merge a Pull Request for that module and there is no minimum amount of time required for the PR to be open before merging.
   This exemption is to be removed when that package makes its first tagged release.
 
 ### Draft Pull Requests

Makefile

@@ -68,6 +68,39 @@ $(GOVULNCHECK): PACKAGE=golang.org/x/vuln/cmd/govulncheck
 
 tools: $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(PORTO) $(MULTIMOD) $(CROSSLINK) $(GOTMPL) $(GORELEASE) $(GOJSONSCHEMA) $(GOVULNCHECK)
 
+# Virtualized python tools via docker
+
+# The directory where the virtual environment is created.
+VENVDIR := venv
+
+# The directory where the python tools are installed.
+PYTOOLS := $(VENVDIR)/bin
+
+# The pip executable in the virtual environment.
+PIP := $(PYTOOLS)/pip
+
+# The directory in the docker image where the current directory is mounted.
+WORKDIR := /workdir
+
+# The python image to use for the virtual environment.
+PYTHONIMAGE := python:3.11.3-slim-bullseye
+
+# Run the python image with the current directory mounted.
+DOCKERPY := docker run --rm -v "$(CURDIR):$(WORKDIR)" -w $(WORKDIR) $(PYTHONIMAGE)
+
+# Create a virtual environment for Python tools.
+$(PYTOOLS):
+# The `--upgrade` flag is needed to ensure that the virtual environment is
+# created with the latest pip version.
+	@$(DOCKERPY) bash -c "python3 -m venv $(VENVDIR) && $(PIP) install --upgrade pip"
+
+# Install python packages into the virtual environment.
+$(PYTOOLS)/%: $(PYTOOLS)
+	@$(DOCKERPY) $(PIP) install -r requirements.txt
+
+CODESPELL = $(PYTOOLS)/codespell
+$(CODESPELL): PACKAGE=codespell
+
 # Generate
 
 .PHONY: generate
@@ -315,3 +348,7 @@ genjsonschema: genjsonschema-cleanup $(GOJSONSCHEMA)
 	mv ${GENERATED_CONFIG}.tmp ${GENERATED_CONFIG}
 	$(MAKE) lint
 	$(MAKE) genjsonschema-cleanup
+
+.PHONY: codespell
+codespell: $(CODESPELL)
+	@$(DOCKERPY) $(CODESPELL)

RELEASING.md

@@ -15,7 +15,7 @@ go.opentelemetry.io/otel packages are compatible with the contrib repository.
 Follow the following steps to verify the changes.
 
 1. Pick the GIT SHA on the [main branch](https://github.com/open-telemetry/opentelemetry-go/commits/main) that you want to verify.
-2. Run the following command to update the OTel depencies with the GIT SHA picked in step 1.
+2. Run the following command to update the OTel dependencies with the GIT SHA picked in step 1.
 
    ```sh
    export GITSHA=<the GIT SHA you want to verify>

config/metric.go

@@ -222,7 +222,7 @@ func prometheusReader(ctx context.Context, prometheusConfig *Prometheus) (sdkmet
 	mux := http.NewServeMux()
 	mux.Handle("/metrics", promhttp.HandlerFor(reg, promhttp.HandlerOpts{Registry: reg}))
 	server := http.Server{
-		// Timeouts are necessary to make a server resilent to attacks, but ListenAndServe doesn't set any.
+		// Timeouts are necessary to make a server resilient to attacks, but ListenAndServe doesn't set any.
 		// We use values from this example: https://blog.cloudflare.com/exposing-go-on-the-internet/#:~:text=There%20are%20three%20main%20timeouts
 		ReadTimeout:  5 * time.Second,
 		WriteTimeout: 10 * time.Second,

detectors/aws/ecs/ecs_test.go

@@ -220,7 +220,7 @@ func TestLogsAttributesAlternatePartition(t *testing.T) {
 		ContainerARN: "arn:arn-partition:arn-svc:arn-region:arn-account:arn-resource",
 	}
 	actualAttributes, err := detector.getLogsAttributes(containerMetadata)
-	assert.NoError(t, err, "failure with nonstandard partitition")
+	assert.NoError(t, err, "failure with nonstandard partition")
 
 	expectedAttributes := []attribute.KeyValue{
 		semconv.AWSLogGroupNames(containerMetadata.LogOptions.AwsLogsGroup),

doc.go

@@ -2,6 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Package contrib is a collection of extensions for the opentelemetry-go
-// project. It provides 3rd parth resource detectors, propagators, samplers,
+// project. It provides 3rd party resource detectors, propagators, samplers,
 // bridges, and instrumentation as submodules.
 package contrib // import "go.opentelemetry.io/contrib"

exporters/autoexport/metrics.go

@@ -65,7 +65,7 @@ func WithFallbackMetricReader(metricReaderFactory func(ctx context.Context) (met
 // Use [WithFallbackMetricReader] option to change the returned exporter
 // when OTEL_METRICS_EXPORTER is unset or empty.
 //
-// Use [IsNoneMetricReader] to check if the retured exporter is a "no operation" exporter.
+// Use [IsNoneMetricReader] to check if the returned exporter is a "no operation" exporter.
 func NewMetricReader(ctx context.Context, opts ...MetricOption) (metric.Reader, error) {
 	return metricsSignal.create(ctx, opts...)
 }
@@ -172,7 +172,7 @@ func init() {
 		mux := http.NewServeMux()
 		mux.Handle("/metrics", promhttp.HandlerFor(reg, promhttp.HandlerOpts{Registry: reg}))
 		server := http.Server{
-			// Timeouts are necessary to make a server resilent to attacks, but ListenAndServe doesn't set any.
+			// Timeouts are necessary to make a server resilient to attacks, but ListenAndServe doesn't set any.
 			// We use values from this example: https://blog.cloudflare.com/exposing-go-on-the-internet/#:~:text=There%20are%20three%20main%20timeouts
 			ReadTimeout:  5 * time.Second,
 			WriteTimeout: 10 * time.Second,

exporters/autoexport/spans.go

@@ -49,7 +49,7 @@ func WithFallbackSpanExporter(spanExporterFactory func(ctx context.Context) (tra
 // Use [WithFallbackSpanExporter] option to change the returned exporter
 // when OTEL_TRACES_EXPORTER is unset or empty.
 //
-// Use [IsNoneSpanExporter] to check if the retured exporter is a "no operation" exporter.
+// Use [IsNoneSpanExporter] to check if the returned exporter is a "no operation" exporter.
 func NewSpanExporter(ctx context.Context, opts ...SpanOption) (trace.SpanExporter, error) {
 	return tracesSignal.create(ctx, opts...)
 }

instrgen/lib/analysis.go

@@ -14,7 +14,7 @@ import (
 	"golang.org/x/tools/go/packages"
 )
 
-// PackageAnalysis analyze all package set accrding to passed
+// PackageAnalysis analyze all package set according to passed
 // pattern. It requires an information about path, pattern,
 // root functions - entry points, function declarations,
 // and so on.

instrumentation/github.com/aws/aws-lambda-go/otellambda/README.md

@@ -73,7 +73,7 @@ type mockHTTPRequest struct {
 func mockEventToCarrier(eventJSON []byte) propagation.TextMapCarrier{
 	var request mockHTTPRequest
 	_ = json.unmarshal(eventJSON, &request)
-	return propogation.HeaderCarrier{someHeaderKey: []string{request.Headers[someHeaderKey]}}
+	return propagation.HeaderCarrier{someHeaderKey: []string{request.Headers[someHeaderKey]}}
 }
 
 type mockPropagator struct{}

instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig/mock_collector_test.go

@@ -185,7 +185,7 @@ func (l *listener) Accept() (net.Conn, error) {
 	return conn, nil
 }
 
-// WaitForConn will wait indefintely for a connection to be estabilished with
+// WaitForConn will wait indefintely for a connection to be established with
 // the listener before returning.
 func (l *listener) WaitForConn() {
 	for {

instrumentation/github.com/aws/aws-sdk-go-v2/otelaws/test/version.go

@@ -3,7 +3,7 @@
 
 package test // import "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws/test"
 
-// Version is the current release version of the AWS intstrumentation test module.
+// Version is the current release version of the AWS instrumentation test module.
 func Version() string {
 	return "0.52.0"
 	// This string is updated by the pre_release.sh script during release

instrumentation/github.com/emicklei/go-restful/otelrestful/config.go

@@ -59,7 +59,7 @@ func WithTracerProvider(provider oteltrace.TracerProvider) Option {
 	})
 }
 
-// WithPublicEndpointFn runs with every request, and allows conditionnally
+// WithPublicEndpointFn runs with every request, and allows conditionally
 // configuring the Handler to link the span with an incoming span context. If
 // this option is not provided or returns false, then the association is a
 // child association instead of a link.

instrumentation/github.com/gorilla/mux/otelmux/config.go

@@ -44,7 +44,7 @@ func WithPublicEndpoint() Option {
 	})
 }
 
-// WithPublicEndpointFn runs with every request, and allows conditionnally
+// WithPublicEndpointFn runs with every request, and allows conditionally
 // configuring the Handler to link the span with an incoming span context. If
 // this option is not provided or returns false, then the association is a
 // child association instead of a link.

instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo/doc.go

@@ -3,7 +3,7 @@
 
 // Package otelmongo instruments go.mongodb.org/mongo-driver/mongo.
 //
-// This package is compatable with v0.2.0 of
+// This package is compatible with v0.2.0 of
 // go.mongodb.org/mongo-driver/mongo.
 //
 // `NewMonitor` will return an event.CommandMonitor which is used to trace

instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo/mongo.go

@@ -95,7 +95,7 @@ func (m *monitor) Finished(evt *event.CommandFinishedEvent, err error) {
 	span.End()
 }
 
-// TODO sanitize values where possible, then reenable `db.statement` span attributes default.
+// TODO sanitize values where possible, then re-enable `db.statement` span attributes default.
 // TODO limit maximum size.
 func sanitizeCommand(command bson.Raw) string {
 	b, _ := bson.MarshalExtJSON(command, false, false)

instrumentation/google.golang.org/grpc/otelgrpc/config.go

@@ -30,7 +30,7 @@ const (
 type InterceptorFilter func(*InterceptorInfo) bool
 
 // Filter is a predicate used to determine whether a given request in
-// should be instrumented by the attatched RPC tag info.
+// should be instrumented by the attached RPC tag info.
 // A Filter must return true if the request should be instrumented.
 type Filter func(*stats.RPCTagInfo) bool
 

instrumentation/net/http/otelhttp/client.go

@@ -12,7 +12,7 @@ import (
 )
 
 // DefaultClient is the default Client and is used by Get, Head, Post and PostForm.
-// Please be careful of intitialization order - for example, if you change
+// Please be careful of initialization order - for example, if you change
 // the global propagator, the DefaultClient might still be using the old one.
 var DefaultClient = &http.Client{Transport: NewTransport(http.DefaultTransport)}
 

instrumentation/net/http/otelhttp/config.go

@@ -100,7 +100,7 @@ func WithPublicEndpoint() Option {
 	})
 }
 
-// WithPublicEndpointFn runs with every request, and allows conditionnally
+// WithPublicEndpointFn runs with every request, and allows conditionally
 // configuring the Handler to link the span with an incoming span context. If
 // this option is not provided or returns false, then the association is a
 // child association instead of a link.

instrumentation/runtime/runtime.go

@@ -24,7 +24,7 @@ type runtime struct {
 
 // config contains optional settings for reporting runtime metrics.
 type config struct {
-	// MinimumReadMemStatsInterval sets the mininum interval
+	// MinimumReadMemStatsInterval sets the minimum interval
 	// between calls to runtime.ReadMemStats().  Negative values
 	// are ignored.
 	MinimumReadMemStatsInterval time.Duration

propagators/autoprop/registry_test.go

@@ -56,7 +56,7 @@ func TestRegistryConcurrentSafe(t *testing.T) {
 		assert.NotPanics(t, func() {
 			v, ok := r.load(propName)
 			assert.True(t, ok, "missing propagator in registry")
-			assert.Equal(t, noop, v, "wrong propagator retuned")
+			assert.Equal(t, noop, v, "wrong propagator returned")
 		})
 	}()
 

propagators/b3/b3_data_test.go

@@ -1010,7 +1010,7 @@ var injectInvalidHeaderGenerator = []injectTest{
 var injectInvalidHeader []injectTest
 
 func init() {
-	// Preform a test for each invalid injectTest with all combinations of
+	// Perform a test for each invalid injectTest with all combinations of
 	// encoding values.
 	injectInvalidHeader = make([]injectTest, 0, len(injectInvalidHeaderGenerator)*4)
 	allHeaders := []string{

renovate.json

@@ -21,6 +21,11 @@
       "matchManagers": ["gomod"],
       "matchDepTypes": ["indirect"],
       "enabled": false
+    },
+    {
+      "matchManagers": ["pip"],
+      "packageNames": ["codespell"],
+      "enabled": true
     }
   ]
 }

requirements.txt

@@ -0,0 +1 @@
+codespell==2.3.0

samplers/aws/xray/internal/reservoir_test.go

@@ -200,7 +200,7 @@ func TestResetQuotaUsageRotation(t *testing.T) {
 		nowTime: 1500000001,
 	}
 
-	// take() should be true since ununsed quota is available
+	// take() should be true since unused quota is available
 	assert.True(t, r.take(clock.now(), false, 1.0))
 }