Document usage of Gradle license plugin.

thehyve · Dec 30, 2024 · 25a5ad0 · 25a5ad0
1 parent ac4f9d0
commit 25a5ad0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/projects/pluto/README.md b/projects/pluto/README.md
@@ -34,4 +34,12 @@ To format the code, run the following command:
 
 NOTE: The Spotless plugin also runs as part of the CI pipeline. Build will fail if the code is not formatted correctly.
 
+### Licenses
 
+The project uses the Gradle license plugin to manage licenses. To check if the licenses of the dependencies 
+are compatible with list of allowed licenses defined in [allowed-licenses.json](allowed-licenses.json),
+run the following command:
+
+```bash
+./gradlew :checkLicense
+```
diff --git a/projects/saturn/README.md b/projects/saturn/README.md
@@ -34,4 +34,12 @@ To format the code, run the following command:
 
 NOTE: The Spotless plugin also runs as part of the CI pipeline. Build will fail if the code is not formatted correctly.
 
+### Licenses
 
+The project uses the Gradle license plugin to manage licenses. To check if the licenses of the dependencies
+are compatible with list of allowed licenses defined in [allowed-licenses.json](allowed-licenses.json),
+run the following command:
+
+```bash
+./gradlew :checkLicense
+```