Skip to content

Commit

Permalink
docs: update docs for package automation (#361)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielpeach authored Oct 3, 2018
1 parent ab1fb64 commit 05ae408
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,15 @@ yarn start

## Publishing @spinnaker/kayenta

This module is published as an NPM package. The current publishing process is manual:
This module is published as an NPM package.

- Create a pull request that increments `package.json`'s patch version - e.g., to `0.0.57`.
- Once the pull request has been merged, run `npm publish` from the root of this repo if you have the NPM permissions to do so. If you don't, ask someone from `@spinnaker/reviewers` to publish the package.
- Once the pull request has been merged, publish a release using the same tag as `package.json`'s version, e.g., `v0.0.57`. `@spinnaker/kayenta` will be automatically published to NPM.

Once `@spinnaker/kayenta` has been published, it's likely that
you'll want to update the main Deck repository: to do so, run `yarn add @spinnaker/kayenta@latest`
in the main Deck repository, then open a pull request.

If you'd like to automate this process, we'd appreciate it.

## Testing

To run `deck-kayenta`'s tests, run `yarn test`.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"main": "lib/lib.js",
"typings": "lib/kayenta/index.d.ts",
"name": "@spinnaker/kayenta",
"version": "0.0.58",
"version": "0.0.59",
"license": "Apache-2.0",
"repository": {
"type": "git",
Expand Down

0 comments on commit 05ae408

Please sign in to comment.