Skip to content

fix: ship LICENSE, NOTICE and README in the published packages #1226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
justFU7 wants to merge 11 commits into
base: master
Choose a base branch
from
Open

fix: ship LICENSE, NOTICE and README in the published packages #1226

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cfe1b15
chore: add script copying root LICENSE/NOTICE/README into a package b…
justFU7 Aug 17, 2026
8481a03
fix(parser): ship LICENSE, NOTICE and README in the published tarball
justFU7 Aug 17, 2026
3692b98
chore(parser): ignore the legal files copied in at pack time
justFU7 Aug 17, 2026
391712e
fix(multi-parser): ship LICENSE, NOTICE and README in the published t…
justFU7 Aug 17, 2026
352b8e0
chore(multi-parser): ignore the legal files copied in at pack time
justFU7 Aug 17, 2026
4750972
fix(openapi-schema-parser): ship LICENSE, NOTICE and README in the pu…
justFU7 Aug 17, 2026
a845d45
chore(openapi-schema-parser): ignore the legal files copied in at pac…
justFU7 Aug 17, 2026
a102ce6
chore: add changeset for the packaged legal files fix
justFU7 Aug 17, 2026
4aa82df
fix: do not overwrite a package that ships its own README
justFU7 Aug 17, 2026
28fb064
fix: keep the tracked README of openapi-schema-parser out of gitignore
justFU7 Aug 17, 2026
afdb541
chore: correct the changeset - openapi-schema-parser ships its own RE…
justFU7 Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/multi-parser/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ node_modules
/cjs
/browser
*.tgz

# copied from the repo root by prepublishOnly (scripts/copy-legal.js)
LICENSE
NOTICE
README.md
4 changes: 3 additions & 1 deletion packages/multi-parser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"/esm",
"/cjs",
"LICENSE",
"NOTICE",
"README.md"
],
"scripts": {
Expand All @@ -36,7 +37,8 @@
"generate:readme:toc": "markdown-toc -i \"../../README.md\"",
"generate:assets": "npm run generate:readme:toc",
"bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
"prepublishOnly": "npm run generate:assets"
"copy:legal": "node ../../scripts/copy-legal.js",
"prepublishOnly": "npm run copy:legal && npm run generate:assets"
},
"dependencies": {
"@asyncapi/avro-schema-parser": "^3.0.3",
Expand Down
5 changes: 5 additions & 0 deletions packages/openapi-schema-parser/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ node_modules
/lib
/esm
/cjs

# copied from the repo root by prepublishOnly (scripts/copy-legal.js)
LICENSE
NOTICE
README.md
4 changes: 3 additions & 1 deletion packages/openapi-schema-parser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"/esm",
"/cjs",
"LICENSE",
"NOTICE",
"README.md"
],
"scripts": {
Expand All @@ -47,7 +48,8 @@
"generate:readme:toc": "markdown-toc -i \"README.md\"",
"generate:assets": "npm run build && npm run generate:readme:toc",
"bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
"prepublishOnly": "npm run generate:assets"
"copy:legal": "node ../../scripts/copy-legal.js",
"prepublishOnly": "npm run copy:legal && npm run generate:assets"
},
"dependencies": {
"@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",
Expand Down
5 changes: 5 additions & 0 deletions packages/parser/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,8 @@ node_modules
/browser
*.tgz
.turbo

# copied from the repo root by prepublishOnly (scripts/copy-legal.js)
LICENSE
NOTICE
README.md
4 changes: 3 additions & 1 deletion packages/parser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"/cjs",
"/browser",
"LICENSE",
"NOTICE",
"README.md"
],
"scripts": {
Expand All @@ -40,7 +41,8 @@
"generate:readme:toc": "markdown-toc -i \"../../README.md\"",
"generate:assets": "npm run generate:readme:toc",
"bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
"prepublishOnly": "npm run generate:assets"
"copy:legal": "node ../../scripts/copy-legal.js",
"prepublishOnly": "npm run copy:legal && npm run generate:assets"
},
"dependencies": {
"@asyncapi/specs": "^6.11.1",
Expand Down
10 changes: 10 additions & 0 deletions scripts/copy-legal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Copy the monorepo-root legal and readme files into the package being published.
// npm only packs files that exist inside the package directory, so without this the published tarballs
// contain no LICENSE, no NOTICE and no README - see the "files" array in each packages/*/package.json.
const fs = require('fs');

Check warning on line 4 in scripts/copy-legal.js

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `node:fs` over `fs`. 


See more on https://sonarcloud.io/project/issues?id=asyncapi_parser-js&issues=AaARP4AS3ej0ChNoZNK7&open=AaARP4AS3ej0ChNoZNK7&pullRequest=1226
const path = require('path');

Check warning on line 5 in scripts/copy-legal.js

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `node:path` over `path`. 


See more on https://sonarcloud.io/project/issues?id=asyncapi_parser-js&issues=AaARP4AS3ej0ChNoZNK8&open=AaARP4AS3ej0ChNoZNK8&pullRequest=1226

const root = path.join(__dirname, '..');
for (const name of ['LICENSE', 'NOTICE', 'README.md']) {
fs.copyFileSync(path.join(root, name), path.join(process.cwd(), name));
}
Loading