docs(cli): use root Readme as CLI Readme #22
Merged
Conversation
This file contains 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
juanchoperezj
approved these changes
Aug 5, 2024
asdolo
force-pushed
the
feat/cli_use_our_repository_as_template
branch
from
ff09887 to
a58b597
Compare
Base automatically changed from
feat/cli_use_our_repository_as_template
to
master
August 5, 2024 16:37
asdolo
force-pushed
the
docs/cli_use_root_readme_as_cli_readme
branch
from
53c8e12 to
b96d1bb
Compare
💯 Test Coverage
😎 Tests Results
👀 Tests Details • (42%)
|
fernandatoledo
approved these changes
Aug 9, 2024
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.
What does this do?
cli/README.mdfile from repository. It had almost the same content as root'sREADME.mdfile.README.mdfile in theclidirectory for it to be shown in the NPM Registry website, so this PR also adds prepack & postpack scripts to the CLI package to copyREADME.mdfrom root tocli/README.mdbefore publishing and removing it after publishing.README.mdfile.1.0.1and manually publish it to npm registry.Why did you do this?
To avoid having a duplicated README file.
Who/what does this impact?
N/A
How did you test this?
I manually published a new version of the CLI with
pnpm publishand I verified that the prepack script was run because npm registry now shows root's README file (with the URLs and typos fixed) instead of the old one from the CLI directory.