From 6ffea7b2461a9500836d263a4ccf257f01ecaec2 Mon Sep 17 00:00:00 2001 From: Damien Mathieu <42@dmathieu.com> Date: Tue, 3 Sep 2024 17:43:31 +0200 Subject: [PATCH] Ensure codespell failures fail CI (#6064) With the `write` option, codespell fixes issues (which is a nice behavior when we run it locally), but it also returns a 0 status code (except if some failures couldn't be fixed). So in order to actually fix the CI on a failing codespell, we need to ensure the working directory is clean. SDK counterpart: https://github.com/open-telemetry/opentelemetry-go/pull/5761 --- .github/workflows/codespell.yml | 3 ++- CHANGELOG.md | 2 +- instrumentation/runtime/internal/x/x.go | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 865596f9f27..7c3a45d42b2 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -11,4 +11,5 @@ jobs: - name: Checkout Repo uses: actions/checkout@v4 - name: Codespell - run: make codespell \ No newline at end of file + run: make codespell + - run: make check-clean-work-tree diff --git a/CHANGELOG.md b/CHANGELOG.md index 68c6eaa7ba7..564503d1493 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -89,7 +89,7 @@ The next release will require at least [Go 1.22]. - The `go.opentelemetry.io/contrib/processors/baggage/baggagetrace` package is deprecated. Use the added `go.opentelemetry.io/contrib/processors/baggagecopy` package instead. (#5824) - Use `baggagecopy.NewSpanProcessor` as a replacement for `baggagetrace.New`. - - `NewSpanProcessor` accepts a `Fitler` function type that selects which baggage members are added to a span. + - `NewSpanProcessor` accepts a `Filter` function type that selects which baggage members are added to a span. - `NewSpanProcessor` returns a `*baggagecopy.SpanProcessor` instead of a `trace.SpanProcessor` interface. The returned type still implements the interface. diff --git a/instrumentation/runtime/internal/x/x.go b/instrumentation/runtime/internal/x/x.go index 2ecb52c0d89..7ffb473adc3 100644 --- a/instrumentation/runtime/internal/x/x.go +++ b/instrumentation/runtime/internal/x/x.go @@ -1,7 +1,7 @@ // Copyright The OpenTelemetry Authors // SPDX-License-Identifier: Apache-2.0 -// Package x contains support for OTel runtime instrumentaiton experimental features. +// Package x contains support for OTel runtime instrumentation experimental features. // // This package should only be used for features defined in the specification. // It should not be used for experiments or new project ideas.