move .md files to published package
#232
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
This moves `README.md`, `LICENSE.md` and `CHANGELOG.md` from the repository root into the `./addon` directory. In doing so, the three files will be picked up by `npm pack` and `npm publish` respectively, so that the npmjs.com listing shows the proper `README.md` instead of an error message, and so that these files are also available in the users `node_modules`. It also adds symlinks from the old location to the new location, so that GitHub still renders the repository overview correctly. It's important, that the files are physically moved instead of just symlinked into the package, as `npm pack` doesn't follow symlinks. `CONTRIBUTING.md` is intentionally not moved, as it's only relevant in the context of the repository.
|
related to embroider-build/embroider#1188 |
|
TIL about markdown symlinking on GH. |
|
@knownasilya do you think this can be merged and published as v8.0.0? At this point of time there is only v8.0.0-beta.0 with v2 addon format conversion and wonder if anything left for the actual release to happen |
|
Probably just #233 |
bertdeblock
reviewed
Apr 11, 2022
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.
This moves
README.md,LICENSE.mdandCHANGELOG.mdfrom the repository root into the./addondirectory.In doing so, the three files will be picked up by
npm packandnpm publishrespectively, so that the npmjs.com listing shows the properREADME.mdinstead of an error message, and so that these files are also available in the usersnode_modules.It also adds symlinks from the old location to the new location, so that GitHub still renders the repository overview correctly. It's important, that the files are physically moved instead of just symlinked into the package, as
npm packdoesn't follow symlinks.CONTRIBUTING.mdis intentionally not moved, as it's only relevant in the context of the repository.