Repository navigation
docs: shorten npm READMEs and ship LICENSE with each package - #103
Merged
Merged
Conversation
sthanikan2000
added
Package/jsonforms-renderers
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The published tarballs had no licence text: the only LICENSE lived at the repo root and `files` is a whitelist. They also showed long or stale READMEs. - Add a LICENSE to packages/auth and packages/jsonforms-renderers, copied from OpenNSW/core, so npm ships it. Fill in the copyright holder in the root LICENSE (it still had the Apache boilerplate placeholder). - Shorten each package README to what it is, install, a minimal example and absolute links to the details in this repo, since that is what npmjs.com shows. The jsonforms-renderers README imported a default export that does not exist; it now uses `radixRenderers` and the styles.css entry. - Move the detailed auth guide to packages/auth/docs/usage.md (not shipped).
sthanikan2000
force-pushed
the
docs/npm-readmes-and-license
branch
from
October 10, 2026 04:36
d44c2e9 to
70c7112
Compare
WebCooper
added a commit
to WebCooper/ui-packages
that referenced
this pull request
Oct 10, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
4 tasks done
Merged
6 tasks done
sthanikan2000
added
skip-changelog
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
The published tarballs ship no licence text: the only
LICENSEis at the repo root, andfilesis a whitelist, so npm doesn't pick it up. The READMEs npm shows are also long (auth) or stale (jsonforms-renderers). This ships aLICENSEwith each package and cuts each README down to what npmjs.com needs, pointing here for the rest.Type of change
Changes made
packages/auth/LICENSEandpackages/jsonforms-renderers/LICENSE, copied fromOpenNSW/core. Fill in the copyright holder in the rootLICENSE, which still had the Apache[yyyy] [name of copyright owner]placeholder (Copyright (c) 2026 Lanka Software Foundation, as incore).docs/isn't published).jsonforms-renderersREADME: fix the example, which imported a default export that doesn't exist (the package exportsradixRenderers, plus@opennsw/jsonforms-renderers/styles.css); drop the control list (7 of many), the relativesrc/…links and thelintcommand (the package has nolintscript).authguide topackages/auth/docs/usage.md(not shipped).Testing
npm pack --dry-run --ignore-scriptsnow listsLICENSEandREADME.mdfor both packages (before, noLICENSE)LICENSEfiles are byte-identical tocore's (same SHA-256)prettier --checkis cleanRelease notes
Each package ships its
LICENSEand the shorter README with its next published version. No API or behaviour change.