Rename license file to satisfy go docs for nested modules #1389
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
The documentation for module `uber.go/zap/exp` is not eligible to be rendered on pkg.go.dev as no license is detected. For example, https://pkg.go.dev/go.uber.org/zap/exp@v0.2.0/zapslog will not render. This is due to some possibly unfortunate behavior in the Go command that special cases copying a `LICENSE` file from the repository for root for any nested modules lacking a `LICENSE` file. This is problematic for Zap as Zap's license is in a file named `LICENSE.txt`. Renaming the license file to `LICENSE` remedies the issue. Relevant issues: - golang/go#43817 (comment) - golang/go#44758 (comment)
|
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1389 +/- ##
=======================================
Coverage 98.42% 98.42%
=======================================
Files 53 53
Lines 3495 3495
=======================================
Hits 3440 3440
Misses 46 46
Partials 9 9 ☔ View full report in Codecov by Sentry. |
r-hang
approved these changes
Nov 27, 2023
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.
The documentation for module
uber.go/zap/expis not eligible to be rendered on pkg.go.dev as no license is detected. For example, https://pkg.go.dev/go.uber.org/zap/exp@v0.2.0/zapslog will not render.This is due to some possibly unfortunate behavior in the Go command that special cases copying a
LICENSEfile from the repository for root for any nested modules lacking aLICENSEfile. This is problematic for Zap as Zap's license is in a file namedLICENSE.txt. Renaming the license file toLICENSEremedies the issue.Relevant issues: