-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(contributing): update publishing docs
- Loading branch information
Showing
1 changed file
with
32 additions
and
5 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,37 @@ | ||
# Contributing | ||
|
||
## Release | ||
Pull requests are welcome! | ||
|
||
To begin, clone the repo, then install dependencies. | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
The source code is written in TypeScript. Spin up the compiler to watch for source changes: | ||
|
||
``` | ||
npm version patch | ||
npm publish | ||
git push | ||
git push --tags | ||
npm run watch | ||
``` | ||
|
||
## Publishing | ||
|
||
CI automatically publishes the next version semantically from analyzing commits in `stable`. To maintain a shared history between `master` and `stable`, the branches must be rebased with each other locally. | ||
|
||
* When it's time to cut a release from `master`: | ||
|
||
``` | ||
git checkout stable | ||
git merge --ff-only master | ||
git push origin stable | ||
``` | ||
|
||
* Await successful publish in CI. Ionitron will push the updated versions and tags to `stable`. | ||
* Sync `master` with `stable`. | ||
|
||
``` | ||
git pull origin stable | ||
git checkout master | ||
git merge --ff-only stable | ||
git push origin master | ||
``` |