Skip to content

Commit

Permalink
docs: update testing wiki
Browse files Browse the repository at this point in the history
- includes docs on how to deploy a local EUI package in Kibana
  • Loading branch information
mgadewoll committed Sep 13, 2024
1 parent 8bcab2a commit 4fa72e0
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion wiki/contributing-to-eui/testing/testing-in-kibana.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4fa72e0

Please sign in to comment.