-
Notifications
You must be signed in to change notification settings - Fork 1
[47] ensure README.md & LICENSE is included in npm package, and add keywords #48
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.
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
Merged
asos-dominicjomaa
merged 22 commits into
ASOS:main
from
TomStrepsil:feat/47-ensure-readme-in-npm-package-and-add-keywords
Sep 29, 2025
Merged
[47] ensure README.md & LICENSE is included in npm package, and add keywords #48
asos-dominicjomaa
merged 22 commits into
ASOS:main
from
TomStrepsil:feat/47-ensure-readme-in-npm-package-and-add-keywords
Sep 29, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* rename to proper module namespace * update docs links * update versions * web toggle point in readme title * fixup changelog from revised 0.x range * 2.0.0 -> 0.5.0 in oss version scheme * fix broken link syntax in CHANGELOG * consistent quoting * more version history issues * fixup module name in jsdoc * add web remove sdkInstanceProvider * remove SDKInstanceProvider * fixup jsdoc dedupe * tweak * clarity re: ssr package * casing etc
* update workflows * version * typo * update chromium linux snaps * versions for serve update * package.json repository field * update root package.lock * bugs & directories/doc fields * fix changelog --------- Co-authored-by: Tom Pereira <tom.pereira@johnlewis.co.uk>
Co-authored-by: Tom Pereira <tom.pereira@johnlewis.co.uk>
Normalise keywords. Add postfix to features package description.
asos-dominicjomaa
approved these changes
Sep 29, 2025
TomStrepsil
commented
Sep 29, 2025
Comment on lines
+46
to
+47
| "prepublishOnly": "shx cp docs/README.md ../../LICENSE . && npm run build", | ||
| "postpublish": "shx rm ./README.md LICENSE", |
Contributor
Author
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These commands pull the README.md and LICENSE files from the appropriate places into the root of the package, so that the publish finds them on the build server.
The postpublish puts them back again (to clean up local workstations, if ever running a --dry-run locally)
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
resolves #47
Details
The packages shown on

npmjs.orgshow a missingREADME.md, and have no keywords:To address:
README.mdcopied to the root of the package (as is the requirement for npmjs.org). However, rather than rescind thedocs/convention of the repository, a temporary copy of this file out ofdocs/is made using aprepublishOnlyscript (and deleted after publish with apostpublishscript, in-case doing a localdry-run).LICENSEis in the repo root, but not copied into the package, and should be based on its notice:example
npm publish --dry-runoutput:packages/**/package.jsonfiles.Scout rule
keywordshad been set naively on the rootpackage.json, and copied over when the peripheral packages were added for the open source version. However, in reality, these keywords are only used to power search on npmjs.org, so for private packages, they make little sense..npmrcpointing to the public registry, to avoidpackage-lock.jsonpollution with private registriesCheckList
main.