docs: Add a note about how to update to latest Core SDK submodule #123
Conversation
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
swyxio
approved these changes
Jun 12, 2021
bergundy
reviewed
Jun 23, 2021
CONTRIBUTING.md
Outdated
| @@ -26,6 +26,8 @@ You will need to submit a CLA before we can accept your contribution. You only h | |||
|
|
|||
| > For cross compilation on MacOS follow [these](https://github.com/temporalio/sdk-node/blob/main/docs/building.md) instructions. | |||
|
|
|||
| To update your environment, run `git submodule update` to update to the latest version of the Core SDK, followed by `npm ci` to recompile. | |||
There was a problem hiding this comment.
Better yet, npm run build after updating the submodule.
No need to reinstall the npm modules.
bergundy
reviewed
Jun 23, 2021
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 was changed
Added a note to contrib docs about how to update Core SDK
Why?
I haven't worked with compiled submodules in Node before so didn't know how to do this, might be worth making a note
Checklist
Closes
How was this tested: