Skip to content

Commit

Permalink
docs(publish): document the updated release process
Browse files Browse the repository at this point in the history
  • Loading branch information
hydrosquall committed Jul 27, 2021
1 parent b2984c8 commit 1c01f50
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ http://vega.github.io/vega-tooltip/

## Installing

We recommend using [Vega-Embed](https://github.com/vega/vega-embed), which already comes with this tooltip plugin.
We recommend using [Vega-Embed](https://github.com/vega/vega-embed), which already comes with this tooltip plugin.

### NPM or Yarn

Expand Down Expand Up @@ -75,6 +75,9 @@ See the [API documentation](docs/APIs.md) for details.
2. Then, type `yarn start`. This will build the library and start a web server.
3. In your browser, navigate to `http://localhost:8000/`, where you can see various Vega-Lite and Vega visualizations with tooltip interaction.

## Release Process
## Publish

To release a new version, make sure that everything works. Then run `yarn version` and bump the version number. Lastly, push to GitHub (with the release tag). [Travis](https://travis-ci.org/vega/vega-tooltip/builds) will build a bundle and make the [npm release](https://www.npmjs.com/package/vega-tooltip) automatically.
Publishing is handled by a 2-branch [pre-release process](https://intuit.github.io/auto/docs/generated/shipit#next-branch-default), configured in `publish.yml`. All changes should be based off the default `next` branch, and are published automatically.

- PRs made into the default branch are auto-deployed to the `next` pre-release tag on NPM. The result can be installed with `npm install vega-tooltip/@next`
- To release a new stable version, open a PR from `next` into `stable` using this [compare link](https://github.com/vega/vega-tooltip/compare/stable...next).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"eslintbase": "beemo eslint .",
"format": "yarn eslintbase --fix && yarn prettierbase --write",
"lint": "yarn eslintbase && yarn prettierbase --check",
"release": "yarn build && auto shipit"
"release": "yarn run prebuild && yarn build && auto shipit"
},
"devDependencies": {
"@auto-it/conventional-commits": "^10.30.0",
Expand Down

0 comments on commit 1c01f50

Please sign in to comment.