superset/superset-frontend/temporary_superset_ui/superset-ui-plugins-deckgl/README.md

43 lines
2.8 KiB
Markdown
Raw Normal View History

2019-09-18 20:21:06 -04:00
# @superset-ui/plugins-deckgl 🔌💡
2019-09-18 19:06:28 -04:00
2019-09-18 20:21:06 -04:00
[![Codecov branch](https://img.shields.io/codecov/c/github/apache-superset/superset-ui-plugins-deckgl/master.svg?style=flat-square)](https://codecov.io/gh/apache-superset/superset-ui-plugins-deckgl/branch/master)
[![Build Status](https://img.shields.io/travis/com/apache-superset/superset-ui-plugins-deckgl/master.svg?style=flat-square)](https://travis-ci.com/apache-superset/superset-ui-plugins-deckgl)
2019-09-18 20:21:06 -04:00
[![David](https://img.shields.io/david/dev/apache-superset/superset-ui-plugins-deckgl.svg?style=flat-square)](https://david-dm.org/apache-superset/superset-ui-plugins-deckgl?type=dev)
2020-02-07 17:16:50 -05:00
[![Netlify Status](https://api.netlify.com/api/v1/badges/4d054ead-0e76-4e03-b684-797ca5924161/deploy-status)](https://app.netlify.com/sites/superset-ui-plugins-deckgl/deploys)
2019-09-18 19:06:28 -04:00
## Demo (Storybook)
2019-09-18 20:21:06 -04:00
Most recent release: https://apache-superset.github.io/superset-ui-plugins-deckgl/
2019-09-18 19:06:28 -04:00
2019-09-18 20:21:06 -04:00
Current master: https://superset-ui-plugins-deckgl.netlify.com
2019-09-18 19:06:28 -04:00
## Packages
| Package | Version |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2019-09-18 20:21:06 -04:00
| [@superset-ui/legacy-preset-chart-deckgl](https://github.com/apache-superset/superset-ui-plugins-deckgl/tree/master/packages/superset-ui-legacy-preset-chart-deckgl) | [![Version](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-deckgl.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-deckgl.svg?style=flat-square) |
2019-09-18 19:06:28 -04:00
2019-09-20 14:15:06 -04:00
## Contribution and development guide
2019-09-18 19:06:28 -04:00
Please read the
[contributing guidelines](https://github.com/apache-superset/superset-ui/blob/master/CONTRIBUTING.md)
which include development environment setup and other things you should know about coding in this
repo.
2019-09-18 19:06:28 -04:00
### Releasing
2021-08-05 05:45:23 -04:00
Make sure you have commit rights to the main `superset-ui-plugins-deckgl` repo, have checked it out
(NOT a fork!) and belong to the `superset-ui` org on npm (=can publish new versions).
1. `yarn install`
2. `yarn build`
2021-08-05 05:45:23 -04:00
3. `yarn release-patch-version`. This will raise an error, but you should see a new commit and tag,
e.g. `v0.4.8`
4. go to the DeckGL directory: `cd packages/superset-ui-legacy-preset-chart-deckgl`
5. make sure you're logged into npm: `npm whoami` should display your npm username.
6. `npm publish`
2019-09-18 19:06:28 -04:00
### License
Apache-2.0