From 4fa72e0f262d2a7f925d7697330ac50bae4698b3 Mon Sep 17 00:00:00 2001 From: Lene Gadewoll Date: Fri, 13 Sep 2024 17:55:57 +0200 Subject: [PATCH] docs: update testing wiki - includes docs on how to deploy a local EUI package in Kibana --- .../testing/testing-in-kibana.md | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/wiki/contributing-to-eui/testing/testing-in-kibana.md b/wiki/contributing-to-eui/testing/testing-in-kibana.md index b2ecb27ab70..c5c079e9953 100644 --- a/wiki/contributing-to-eui/testing/testing-in-kibana.md +++ b/wiki/contributing-to-eui/testing/testing-in-kibana.md @@ -23,9 +23,32 @@ yarn kbn bootstrap --no-validate && yarn start ``` * The `--no-validate` flag is required when bootstrapping with a `.tgz`. - * Change the name of the `.tgz` after subsequent `yarn build && yarn pack` steps (e.g., `elastic-eui-xx.x.x-1.tgz`, `elastic-eui-xx.x.x-2.tgz`). This is required for `yarn` to recognize new changes to the package. + * Change the name of the `.tgz` after subsequent `yarn build-pack` steps (e.g., `elastic-eui-xx.x.x-1.tgz`, `elastic-eui-xx.x.x-2.tgz`). This is required for `yarn` to recognize new changes to the package. * Running Kibana with `yarn start` ensures it starts in dev mode and doesn't use a previously cached version of EUI. +### Deploying local EUI in Kibana + +If you want to deploy a local EUI package in Kibana you can do the following: + +#### Generate and link a local EUI package + +- Follow the steps above to create a local package of EUI using `yarn build-pack` +- Copy the generated `.tgz` package file to the Kibana root +- Point the `package.json` file in Kibana to that local file: `"@elastic/eui": "./elastic-eui-xx.x.x.tgz"`. +- Run `yarn kbn bootstrap` +- Commit the changed files (`package.json`. `yarn.lock` and EUI `.tgz` package) and push your branch +- Create a Kibana (draft) pull request + +#### Deploy the custom EUI package + +There are two ways you can deploy your local EUI package in Kibana. + +1. add the labels `ci:cloud-deploy` and `ci:cloud-persist-deployment` on your PR and ensure the CI pipelines run + - after the pipelines finish the "Build" information will have a link to the cloud deployment and access information ([vault access](https://docs.elastic.dev/vault/infra-vault/accessing) is required) +2. use [Kibana-a-la-carte](https://kibana-a-la-carte.kbndev.co/) to deploy your PR + + + ## Testing in the cloud Elastic engineers have the option of deploying a specific branch of EUI against a specific branch of Kibana in the cloud in a development environment. For more information, see: