Skip to content

Commit

Permalink
chore(contributing): update publishing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
imhoffd committed May 29, 2019
1 parent e361189 commit 944fa13
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions CONTRIBUTING.md
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
```

0 comments on commit 944fa13

Please sign in to comment.