Skip to content

Commit dbe0d8c

Browse files
committed
Explain the idea.
1 parent 9fe31df commit dbe0d8c

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

js/oss-licenses.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,17 @@ $(
1313
const repoName = 'repo-name';
1414

1515
/**
16-
* Loads `license-report` file from the repository.
16+
* Loads the dependency report file from the repository.
17+
*
18+
* <p>There may be one of two report files present in the repo: `license-report.md`
19+
* or `dependencies.md`. The latter is a newer version of the report, so it is loaded
20+
* first. In case it is missing, `license-report.md` is loaded, as a fallback.
21+
* Eventually, all Spine repositories will migrate to having `dependencies.md`.
22+
*
23+
* <p>The report sections describing the terms of use for dual-licensed dependencies,
24+
* and another one with the credits paid to the author of Gradle plugin
25+
* we use for reporting, are removed from DOM, as they are now moved
26+
* to the static part of the page (see `/oss-licenses.index.html`).
1727
*
1828
* <p>Executes by clicking on the corresponding link. The destination `div` element
1929
* should have the `id` like `md-destination-REPO_NAME`.

0 commit comments

Comments
 (0)