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

Chore: canvas build on bootstrap (#24175)

Browse source 
Closes https://github.com/elastic/kibana/issues/23287

Adds `kbn:bootstrap` script to Canvas that builds the core Canvas plugins. This means users no longer need to run the step manually. This should also fix snapshots.
This commit is contained in:
Joe Fleming 2018-10-22 12:13:43 -07:00 • committed by joe fleming
parent 3adfdd5123
commit 1398cc892e
2 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
x-pack/package.json
View file

@ -7,6 +7,7 @@
"scripts": {
"preinstall": "node ../preinstall_check",
"kbn": "node ../scripts/kbn",
"kbn:bootstrap": "gulp canvas:plugins:build",
"start": "gulp dev",
"build": "gulp build",
"testonly": "gulp testonly",

10
x-pack/plugins/canvas/README.md
View file

@ -6,7 +6,7 @@
Canvas is included with X-Pack and requires a Basic license or better to use.
To run Canvas from dev mode, you'll need to build the Canvas plugins at least once. To do so, use the following command:
Canvas has its own build pipeline that gets triggered as part of `yarn kbn bootstrap`. However, should you ever need to run the build manually, like if you updated one of the plugins, you can do so with the following command:
```bash
yarn kbn run build:plugins --include canvas
@ -14,9 +14,9 @@ yarn kbn run build:plugins --include canvas
### Developing in Canvas
Canvas has its plugin build process, so if you are planning to work on any of the plugin code, you'll need to use the plugin build process.
As mentioned above, Canvas has its plugin build process, so if you are planning to work on any of the plugin code, you'll need to use the plugin build process.
**If you are not working on Canvas plugins, you can just start Kibana like normal, as long as you ran the build command above at least once**.
**If you are not working on Canvas plugins, you can just start Kibana like normal, as long as you've used `yarn kbn bootstrap`**.
The easiest way to do develop on Canvas and have the plugins built automatically is to cd into the canvas plugin path and start the process from there:
@ -28,9 +28,9 @@ yarn start
There are several other scripts available once you are in that path as well.
- `yarn build:plugins` - local alias to build Canvas plugins, an alternative to use `kbn`.
- `yarn build:plugins` - local alias to build Canvas plugins, an alternative to using `kbn`.
- `yarn lint` - local linter setup, can also be used with the `--fix` flag for automatic fixes.
- `yarn test` - local test runner, does not require a real Kibana instance. Runs all the same unit tests the normal runner does, just limited to Canvas, and *waaaaaay* faster.
- `yarn test` - local test runner, does not require a real Kibana instance. Runs all the same unit tests the normal runner does, just limited to Canvas, and *waaaaaay* faster (currently 12 seconds or less).
- `yarn test:dev` - Same as above, but watches for changes and only runs tests for the given scope (browser, server, or common).
## Feature Questions