fix: npm readme #136
Merged
fix: npm readme #136
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
|
Even though this is just a symbolic link, do we need to have the same file content twice in the repo? |
|
That would work for me too. I'll work on that. |
|
@francardoso93 changes made |
| @@ -65,6 +65,7 @@ jobs: | |||
| run: | | |||
| cd npm | |||
| ./publish.sh | |||
| ln ../README.md README.md | |||
There was a problem hiding this comment.
This needs to run before the publish.sh script
There was a problem hiding this comment.
Also, you need to remove the existing README.md to avoid conflict
|
Currently the symlinks are being created both on commited files AND dynamically through workflow. Now they should go with only one of these approaches |
|
@francardoso93 changes made. |
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 PR creates a symbolic link to README.md in the
npmfolder so the same readme is displayed in GitHub and NPM.To test: clone this branch and see if the npm/README.md file is populated. We also will need to check the next release to see if the README will be populated in the NPM website.
Closes #137