Skip to content

update contrib/README.md #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2020
Merged

update contrib/README.md #387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions contrib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,31 @@

### Summary

This project follows [Semantic Versioning 2.0](https://semver.org/). In general, every release is associated with a tag and a changelog. `master` serves as the mainline branch for the project and represent the latest state of development.
This project follows [Semantic Versioning 2.0](https://semver.org/). In general, every release is associated with a tag and a changelog. `support/3.x` serves as the mainline branch for the project and represents the latest state of development.

### Publishing a New SDK version
```bash
# fetch and rebase from upstream/support/3.x
git fetch upstream support/3.x
git rebase upstream/support/3.x

# checkout a release branch
git checkout -b release/3.<x>.<y>

# run bump_version.bash with either patch, minor, or major
./bump_version.bash <patch|minor|major>

# push changes to your remote origin
git push origin release/3.<x>.<y>

# open a PR from that remote branch to support/3.x and get it reviewed
# merge branch after approval

# make live
git push upstream && git push upstream --tags
git push upstream --tags
npm publish

npm deprecate mongodb-stitch "The browser SDK has moved to mongodb-stitch-browser-sdk, and the Node.js SDK has moved to mongodb-stitch-server-sdk"

# send an email detailing the changes to the https://groups.google.com/d/forum/mongodb-stitch-announce mailing list
```

### Patch Versions
Expand Down