[chore] Use crosslink tidylist in make gotidy (attempt 2)
#37418
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
bogdandrutu
approved these changes
Jan 22, 2025
codeboten
approved these changes
Jan 22, 2025
codeboten
reviewed
Jan 22, 2025
| @@ -0,0 +1,12 @@ | |||
| # This file lists modules that are known to have intra-repository circular dependencies. | |||
There was a problem hiding this comment.
not strictly necessary to move these, but maybe they would be better suited under internal/buildscripts or in the .github directory?
There was a problem hiding this comment.
Since those files aren't scripts and aren't used as part of building the Collector, and they're used as part of local development rather than CI, those directories didn't feel appropriate, but maybe I can move it into buildscripts if we relax the definition a bit?
There was a problem hiding this comment.
@codeboten What do you think would be the best location for these files?
|
Merging this PR, @codeboten PTAL at #37418 (comment) and if there are any follow ups we can do them in a separate PR |
|
needs |
chengchuanpeng
pushed a commit
to chengchuanpeng/opentelemetry-collector-contrib
that referenced
this pull request
Feb 8, 2025
…elemetry#37418) #### Description This is a second attempt at PR open-telemetry#37142, see that one for context. The PR was reverted in open-telemetry#37173, because the result of `make tidylist` was not a pure function of the repo state. The output of the tool depends on all `go.mod` files present in the repo directory, including those that may be `.gitignored`, such as the ones generated in `cmd/otelcontribcol` and `cmd/oteltestbedcol`. Since then, I [added a `--skip` flag to the tool](open-telemetry/opentelemetry-go-build-tools#662), which allows us to make the tool ignore these problematic `go.mod` files. Automatic detection of `.gitignored` files may be desirable if some developers have other non-gitted Go modules inside their repo directory. As this would require more advanced Git integration in the tool and should be easily avoided, I've decided to keep this more manual approach. #### Link to tracking issue Resolves open-telemetry#37336. See previous PR for impacted issues in core. #### Testing See previous PR for initial testing. I've tried running the tool locally, with and without the generated files in `cmd/otelcontribcol`, and the output was identical, confirming that the previous issue should be fixed. --------- Co-authored-by: Pablo Baeyens <[email protected]>
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.
Description
This is a second attempt at PR #37142, see that one for context.
The PR was reverted in #37173, because the result of
make tidylistwas not a pure function of the repo state. The output of the tool depends on allgo.modfiles present in the repo directory, including those that may be.gitignored, such as the ones generated incmd/otelcontribcolandcmd/oteltestbedcol.Since then, I added a
--skipflag to the tool, which allows us to make the tool ignore these problematicgo.modfiles.Automatic detection of
.gitignoredfiles may be desirable if some developers have other non-gitted Go modules inside their repo directory. As this would require more advanced Git integration in the tool and should be easily avoided, I've decided to keep this more manual approach.Link to tracking issue
Resolves #37336.
See previous PR for impacted issues in core.
Testing
See previous PR for initial testing.
I've tried running the tool locally, with and without the generated files in
cmd/otelcontribcol, and the output was identical, confirming that the previous issue should be fixed.