Fix false negatives in the docpaths workflow #321
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In `CheckDocsPathsForMissingRedirects`, a `trace.Wrap` call mistakenly includes an unrelated error as an argument, and the error is either nil or handled earlier in the function. This means that docs pull requests with insufficient redirects still cause the workflow to pass. This change fixes the issue and adds testing for error handling in `CheckDocsPathsForMissingRedirects`. As part of this, it improves some other error messages returned by the function.
ptgott
force-pushed
the
paul.gottschling/2025-02-05-redirect-check-fix
branch
from
98ffa9f to
6e283d5
Compare
zmb3
approved these changes
Feb 7, 2025
bot/internal/bot/docpaths.go
Outdated
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/gravitational/shared-workflows/bot/internal/github" | ||
| "github.com/gravitational/trace" | ||
| "github.com/spf13/afero" |
There was a problem hiding this comment.
Can we use io/fs instead of pulling in a dependency?
Use the OS FS per feedback from zmb3.
camscale
approved these changes
Feb 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In
CheckDocsPathsForMissingRedirects, atrace.Wrapcall mistakenly includes an unrelated error as an argument, and the error is either nil or handled earlier in the function. This means that docs pull requests with insufficient redirects still cause the workflow to pass.This change fixes the issue and adds testing for error handling in
CheckDocsPathsForMissingRedirects. As part of this, it improves some other error messages returned by the function.