chore: license the project under mit
- add the mit LICENSE and set license and author in all package.json files, plus a license section in the readme - generate the license notices of all shipped production dependencies and node.js in a dockerfile stage and serve them at /licenses.txt, linked from the sidebar footer - keep license files when slimming node_modules in the image - add oci labels, with the version passed in by ci - document licensing in the development docs - bump version to 1.22.2
This commit is contained in:
1 parent
531754c3fa
commit
bba6eb2f94
14 files changed
+260
-14
No files matched your search
@@ -218,6 +218,29 @@ docker compose build --no-cache
|
||||
|
||||
---
|
||||
|
||||
## Licenses
|
||||
|
||||
The project is MIT-licensed ([LICENSE](../LICENSE)); the `license` field in all three `package.json` files says the same.
|
||||
|
||||
The image ships third-party code: the server's production dependencies, the client's production dependencies (bundled into its build), the Node.js binary, Chromium and Debian packages. Their notices are in the image as follows:
|
||||
|
||||
- **npm packages and Node.js**: the `licenses` stage of the Dockerfile runs `scripts/third-party-licenses.mjs`, which writes the project's LICENSE followed by every production dependency of both workspaces with its license files (or, for the few packages that ship none, the declared license, author and source). Node.js's LICENSE for the exact version in the image is fetched from GitHub and appended. The result is `/app/client/licenses.txt`, which the app serves at `/licenses.txt`. The build fails if a package has no license information at all.
|
||||
- **Server packages' own license files** stay in `node_modules`: the slimming step deletes Markdown files except `LICENSE*`, `NOTICE*` and `COPYING*`.
|
||||
- **Chromium**: `LICENSE.headless_shell` next to the binary under `/ms-playwright`.
|
||||
- **Debian packages**: `/usr/share/doc/*/copyright`.
|
||||
|
||||
The image also has the OCI labels `org.opencontainers.image.licenses=MIT`, `source`, `title` and `version` (CI passes the version as the `VERSION` build arg).
|
||||
|
||||
To check the notices locally, or to review a new dependency's license, run from the repository root:
|
||||
|
||||
```bash
|
||||
node scripts/third-party-licenses.mjs > /tmp/licenses.txt
|
||||
```
|
||||
|
||||
Before adding a dependency, check its license is compatible with MIT distribution (permissive licenses such as MIT, ISC, BSD, Apache-2.0 are; copyleft ones such as GPL or AGPL need a closer look).
|
||||
|
||||
---
|
||||
|
||||
## CI (Gitea Actions)
|
||||
|
||||
`.gitea/workflows/ci.yml` runs on pushes to `master` and on pull requests:
|
||||
|
||||
Reference in new issue
Block a user