Skip to content

Commit 1558e79

Browse files
author
deleonn
committed
Update release docs and add circleci badge to readme
1 parent 4a820db commit 1558e79

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# particle-api-js
22
JS Library for the Particle Cloud API for Node.js and the browser
33

4-
[![Build Status](https://travis-ci.org/particle-iot/particle-api-js.svg?branch=master)](https://travis-ci.org/particle-iot/particle-api-js)
4+
[![Build Status](https://circleci.com/gh/particle-iot/particle-api-js.svg?style=shield&circle-token=e41d6332462903a16e5e172ae045909281c60736)](https://app.circleci.com/pipelines/github/particle-iot/particle-api-js)
55

66
## Installation
77

RELEASE.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# Releasing a new version
22

3-
- `npm version <major | minor | patch>`
4-
5-
This builds the distribution file `particle.js.min` and generates the
6-
API documentation. Before the command finishes, update `CHANGELOG.md`.
7-
8-
- `git push && git push --tags`
9-
10-
- Travis will run `npm publish` if the build passes.
11-
12-
- Create a release on GitHub with the notes from the `CHANGELOG.md`
3+
1. Merge your changes to master and be on `master`
4+
2. Run `npm version <major|minor|patch>`
5+
1. This builds the distribution file `particle.js.min` and generates the
6+
API documentation. Before the command finishes, update `CHANGELOG.md`.
7+
3. Push to origin `git push --follow-tags`
8+
4. CircleCI will publish the npm package to the `latest` tag
9+
5. Create a release on GitHub with the notes from the `CHANGELOG.md`
10+
6. Point your project to the new version `npm install particle-api-js@latest`
1311

1412
- After updating major version, update the installation instructions in the [docs](https://github.com/particle-iot/docs/blob/master/src/content/reference/SDKs/javascript.md)

0 commit comments

Comments
 (0)