Skip to content

Commit

Permalink
Rename license file to satisfy go docs for nested modules (#1389)
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
lrewega authored Nov 27, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent fa1b6ae commit 5acd569
Showing 3 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .readme.tmpl
Original file line number Diff line number Diff line change
@@ -92,7 +92,7 @@ standard.

<hr>

Released under the [MIT License](LICENSE.txt).
Released under the [MIT License](LICENSE).

<sup id="footnote-versions">1</sup> In particular, keep in mind that we may be
benchmarking against slightly older versions of other packages. Versions are
File renamed without changes.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -123,7 +123,7 @@ standard.

<hr>

Released under the [MIT License](LICENSE.txt).
Released under the [MIT License](LICENSE).

<sup id="footnote-versions">1</sup> In particular, keep in mind that we may be
benchmarking against slightly older versions of other packages. Versions are

0 comments on commit 5acd569

Please sign in to comment.