github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[6.x] [plugin-helpers] update readme (#16616) (#16620)

Browse source 
* [plugin-helpers] update the readme to describe changes now that it is in the Kibana repo

* [plugin-helpers/readme] add note about versions before 6.3
This commit is contained in:
Spencer 2018-02-10 00:32:40 -07:00 • committed by GitHub
parent 247e43dab4
commit 65fefe4cb9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

31
packages/kbn-plugin-helpers/README.md
View file

@ -1,10 +1,23 @@
# kibana-plugin-helpers
[![Apache License](https://img.shields.io/badge/license-apache_2.0-a9215a.svg)](https://raw.githubusercontent.com/elastic/kibana-plugin-helpers/master/LICENSE)
[![CircleCI](https://img.shields.io/circleci/project/github/elastic/kibana-plugin-helpers.svg)](https://circleci.com/gh/elastic/kibana-plugin-helpers/tree/master)
# @kbn/plugin-helpers
Just some helpers for kibana plugin devs.
## Installation
To install the plugin helpers use `yarn` to link to the package from the Kibana project:
```sh
yarn add --dev link:../../kibana/packages/kbn-plugin-helpers
```
This will link the package from the repository into your plugin, but the `plugin-helpers` executable won't be available in your project until you run bootstrap again.
```sh
yarn kbn bootstrap
```
## Usage
This simple CLI has several tasks that plugin devs can run from to easily debug, test, or package kibana plugins.
```sh
@ -29,15 +42,13 @@ $ plugin-helpers help
## Versions
Plugin Helpers | Kibana
-------------- | ------
7.x | 4.6+ (node 6+ only)
6.x | 4.6+
5.x | 4.x
The plugins helpers in the Kibana repo are available for Kibana 6.3 and greater. Just checkout the branch of Kibana you want to build against and the plugin helpers should be up to date for that version of Kibana.
When you're targeting versions before Kibana 6.3, use the `@elastic/plugin-helpers` from npm. See the [versions](https://github.com/elastic/kibana-plugin-helpers#versions) section of the [`@elastic/plugin-helpers` readme](https://github.com/elastic/kibana-plugin-helpers) for information about version compatibility.
## Configuration
`plugin-helpers` accepts a number of settings, which can be specified at runtime, or included in a `.kibana-plugin-helpers.json` file if you'd like to bundle those settings with your project.
`plugin-helpers` accepts a number of settings, which can be specified at runtime, or included in a `.kibana-plugin-helpers.json` file if you'd like to bundle those settings with your project.
It will also observe a `.kibana-plugin-helpers.dev.json`, much like Kibana does, which we encourage you to add to your `.gitignore` file and use for local settings that you don't intend to share. These "dev" settings will override any settings in the normal json config.