Repository navigation
docs: add npm READMEs and publish codemod - #1936
Merged
Merged
Conversation
npm showed no README for any @ui-kitten package ("No README data
found!"), so a 5.x user on npmjs.com saw no install line, no v6
notice and no migration link. Every published package now ships a
README with install, usage and the migration guide; homepage points
at the documentation site instead of the GitHub README anchor.
@ui-kitten/codemod was private, so the `npx @ui-kitten/codemod`
command in the migration guide and README did not work. Unmark it,
drop the "not published yet" note, and document the manual first
publish a new package needs under trusted publishing.
Merged
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
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.
Why
npm view @ui-kitten/components readmereturnsNo README data found!, for 6.2.0 and for 5.3.1. A 5.x user who lands on npmjs.com sees no install line, no "v6 is out" notice and no migration link. Last week 76% of@ui-kitten/componentsinstalls were still 5.3.1 and 3% were 6.x.@ui-kitten/codemodisprivate: true, so thenpx @ui-kitten/codemodcommand that the migration guide and README advertise fails.What
README.mdfor every published package.componentscarries the full install / quick start / packages table; the other eight are short: what it is, install, one usage snippet, docs link, migration pointer.homepagein everypackage.jsonpoints at the documentation site instead of the GitHub README anchor.@ui-kitten/codemodis no longer private. The "not published yet" admonition is removed from the migration guide; root README now saysnpx @ui-kitten/codemod.RELEASING.md: npm writes from a developer machine work from an interactive terminal via web auth (verified today withnpm dist-tag rm); non-interactive shells get a bare 403. New section on the manual first publish a new package needs under trusted publishing.Release order for the codemod
Trusted publishing only works for packages that already exist on npm. Before merging the Version PR that follows this one:
yarn workspace @ui-kitten/codemod build && cd src/codemod && npm publish --access public@ui-kitten/codemod→ Settings → add trusted publisherakveo/react-native-ui-kitten/release.ymlVerification
yarn workspace @ui-kitten/codemod buildandnpm pack --dry-runinsrc/codemod: README,bin/,lib/commonjsincluded, 82 files, 110 kB.node bin/ui-kitten-codemod --helpruns.yarn jest src/codemod --runInBand: 3 suites, 451 tests pass.MomentDateService(locale),DateFnsService(locale, { formatOptions, parseOptions }),SchemaProcessor().process(mapping)run against the Eva mapping,createMapping/mergeMappingexports,ui-kitten bootstrapCLI command.