DOCSP-4862 Add script to update browser sdk README versions #254
Conversation
adamchel
left a comment
adamchel
left a comment
There was a problem hiding this comment.
Looks good, except that the changes need to get committed before a publish. should be good after this but I wanna take another quick look then
|
|
||
| ```bash | ||
| lerna publish --force-publish="*" | ||
| ./update_browser_readme_version.sh |
There was a problem hiding this comment.
[minor] this should go before lerna publish, otherwise the READMEs on npmjs.com will show an old version.
| sed -i '' \ | ||
| -e "s#\(stitch-sdks/js/bundles/\)[0-9\.]*\(/stitch\)#\1$VERSION_MAJOR.$VERSION_MINOR.$VERSION_PATCH\2#g" \ | ||
| ../packages/browser/sdk/README.md | ||
| echo "README updated." |
There was a problem hiding this comment.
[minor] To make sure this gets committed before a publish you should add
git add ../packages/browser/sdk/README.md
git commit -m "Update SDK version to $VERSION_MAJOR.$VERSION_MINOR.$VERSION_PATCH in relevant READMEs"
There was a problem hiding this comment.
I'm not sure how I feel about adding git commands in a script... Wouldn't this violate the principle of least astonishment? I wouldn't expect a script to make a commit on my behalf.
There was a problem hiding this comment.
I put the reminder to commit in the contrib/README.md. Thoughts?
Please run contrib/update_browser_readme_version.sh when releasing/publishing docs.
cbush
force-pushed
the
add-readme-version-updater
branch
from
d1da23a to
0f18a39
Compare
cbush
force-pushed
the
add-readme-version-updater
branch
from
0f18a39 to
e77c88f
Compare
| fi | ||
|
|
||
| echo "README updated." | ||
| git add -u "../packages/browser/sdk/README.md" |
There was a problem hiding this comment.
[q] why git add -u? we don't want to add all changes
There was a problem hiding this comment.
-u is just update which means it won't add that file if it wasn't already tracked. Not really necessary I suppose but it doesn't hurt either.
- Note in README that you should not do this on a dirty repo (though it will fail out anyway)
cbush
force-pushed
the
add-readme-version-updater
branch
from
1ca3847 to
3a2ae7d
Compare
3 participants
Please run contrib/update_browser_readme_version.sh when releasing/publishing
docs.