github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/packages/kbn-relocate
History
Exact
Gerard Soldevila a41badf964
SKA: Misc cleanup and enhancements (#212207) 
## Summary

* Remove some old paths pointing to `packages/kbn-pm` (no longer
exists).
* ~Fix group and visibility for `@kbn/streams-app-wrapper-plugin`~.
(done in https://github.com/elastic/kibana/pull/212210)
* Update `scripts/relocate` logic with latest enhancements.
* Convert `@kbn/observability-synthetics-test-data` folder name to
camel-case (messes up with pre-commit hook).
2025-02-24 13:31:00 +00:00
..
utils SKA: Misc cleanup and enhancements (#212207) 2025-02-24 13:31:00 +00:00
constants.ts SK: Relocate Script v7.2 (#207081) 2025-01-20 15:43:32 +01:00
healthcheck.ts SK: Relocate Script v7.2 (#207081) 2025-01-20 15:43:32 +01:00
index.ts SK: Relocate Script v7.2 (#207081) 2025-01-20 15:43:32 +01:00
jest.config.js Sustainable Kibana Architecture: Add scripts/relocate CLI (beta) (#203803) 2024-12-11 17:10:37 +01:00
kibana.jsonc Sustainable Kibana Architecture: Add scripts/relocate CLI (beta) (#203803) 2024-12-11 17:10:37 +01:00
list.ts SKA: Relocate "platform" packages that remain on /packages (#208704) 2025-02-24 11:03:30 +00:00
package.json Sustainable Kibana Architecture: Add scripts/relocate CLI (beta) (#203803) 2024-12-11 17:10:37 +01:00
README.md Sustainable Kibana Architecture: Relocate script v4 (#204383) 2024-12-16 09:45:31 -06:00
relocate.ts SKA: Misc cleanup and enhancements (#212207) 2025-02-24 13:31:00 +00:00
tsconfig.json Sustainable Kibana Architecture: Add scripts/relocate CLI (beta) (#203803) 2024-12-11 17:10:37 +01:00
types.ts Sustainable Kibana Architecture: Relocate script v5 (#204461) 2024-12-17 04:04:48 -06:00

README.md

@kbn/relocate

This package contains a CLI tool to help move modules (plugins and packages) into their intended folders, according to the _Sustainable Kibana Architecture.

Prerequisites

You must have gh CLI tool installed. You can install it by running:

brew install gh
gh auth login

Usage

First of all, you need to decide whether you want to contribute to an existing PR or to create a new one. Use the --pr flag to specify the PR you are trying to update:

node scripts/relocate --pr <prNumber>

Note that when specifying an existing PR, the logic will undo + rewrite history for that PR, by force-pushing changes.

To relocate modules for a given team, identify the "team handle" (e.g. @elastic/kibana-core), and run the following command from the root of the Kibana repo:

node scripts/relocate --pr <prNumber> --team <team_handle>

You can relocate modules by path, e.g. all modules that are under x-pack/plugins/observability_solution/:

node scripts/relocate --pr <prNumber> --path "x-pack/plugins/observability_solution/"

You can specify indivual packages by ID:

node scripts/relocate --pr <prNumber> --include "@kbn/data-forge" --include "@kbn/deeplinks-observability"

You can also specify combinations of the above filters, to include modules that match ANY of the criteria. Excluding modules explictly is also supported:

node scripts/relocate --pr <prNumber> --team "@elastic/obs-ux-management-team" --exclude "@kbn/data-forge"

Details

The script generates log / description files of the form relocate_YYYYMMDDhhmmss_<type>.out. You can inspect them if you encounter any errors.

In particular, the file relocate_YYYYMMDDhhmmss_description.out contains the auto-generated PR description. You can push it to the PR by running:

gh pr edit <prNumber> -F relocate_YYYYMMDDhhmmss_description.out -R elastic/kibana