Skip to content

Commit

Permalink
Ensure codespell failures fail CI (#6064)
Browse files Browse the repository at this point in the history
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:
open-telemetry/opentelemetry-go#5761
  • Loading branch information
dmathieu authored Sep 3, 2024
1 parent b56f243 commit 6ffea7b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ jobs:
- name: Checkout Repo
uses: actions/checkout@v4
- name: Codespell
run: make codespell
run: make codespell
- run: make check-clean-work-tree
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/runtime/internal/x/x.go
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 6ffea7b

Please sign in to comment.