Skip to content

Commit 7085ba6

Browse files
Merge pull request #300 from SgtCoDFish/licenses-dist
Improve text in licenses template
2 parents a7819ed + 8aeedd1 commit 7085ba6

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

modules/licenses/licenses.tmpl

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,38 @@
1-
This LICENSES file is generated by the `licenses` module in makefile-modules.
1+
This LICENSES file is generated by the `licenses` module in makefile-modules[0].
22

3-
The licenses below the "---" are determined by the go-licenses tool.
3+
The licenses below the "---" are determined by the go-licenses tool[1].
44

55
The aim of this file is to collect the licenses of all dependencies, and provide
66
a single source of truth for licenses used by this project.
77

8+
## For Developers
9+
810
If CI reports that this file is out of date, you should be careful to check that the
911
new licenses are acceptable for this project before running `make generate-go-licenses`
1012
to update this file.
1113

12-
Acceptable licenses are those allowlisted by the CNCF[0].
14+
Acceptable licenses are those allowlisted by the CNCF[2].
1315

1416
You MUST NOT add any new dependencies whose licenses are not allowlisted by the CNCF,
15-
or which do not have an explicit license exception[1].
17+
or which do not have an explicit license exception[3].
18+
19+
## For Users
20+
21+
If this file was included in a release artifact, it is a snapshot of the licenses of all dependencies at the time of the release.
22+
23+
You can retrieve the actual license text by following these steps:
24+
25+
1. Find the dependency name in this file
26+
2. Go to the source code repository of this project, and go to the tag corresponding to this release.
27+
3. Find the exact version of the dependency in the `go.mod` file
28+
4. Search for the dependency at the correct version in the [Go package index](https://pkg.go.dev/).
29+
30+
## Links
1631

17-
[0]: https://github.com/cncf/foundation/blob/db4179134ebe7fa00b140a050c19147db808b6fa/policies-guidance/allowed-third-party-license-policy.md#cncf-allowlist-license-policy
18-
[1]: https://github.com/cncf/foundation/blob/db4179134ebe7fa00b140a050c19147db808b6fa/license-exceptions/README.md
32+
[0]: https://github.com/cert-manager/makefile-modules/
33+
[1]: https://github.com/google/go-licenses
34+
[2]: https://github.com/cncf/foundation/blob/db4179134ebe7fa00b140a050c19147db808b6fa/policies-guidance/allowed-third-party-license-policy.md#cncf-allowlist-license-policy
35+
[3]: https://github.com/cncf/foundation/blob/db4179134ebe7fa00b140a050c19147db808b6fa/license-exceptions/README.md
1936

2037
---
2138

0 commit comments

Comments
 (0)