add kibana.jsonc files to existing packages by spalger · Pull Request #138965 · elastic/kibana

spalger · 2022-08-17T00:30:46Z

⚠️ Reviewers ⚠️

Beyond the code-owner specific changes you see will you also please search for the new lines in .github/CODEOWNERS that mention your team/teams? These new lines represent the packages for which your team has been assigned ownership. Ownership is now going to automatically create codeowner entries so you don't need to manually setup codeowner-entries anymore.

This PR implements the new kibana.jsonc package manifest file which will be the only "boilerplate" file in packages and will include the details necessary to generate all other metadata files on-demand. This file's schema was outlined in #137611 and is relatively sparse on details for now. I'll be working on generating package.json files based on the kibana.json file next.

Improvements:

node scripts/generate package now asks for the name of the package interactively when not specified on the command line.
The "owner" field in kibana.jsonc is required to be a string starting with @ and is injected into the codeowners file as the default codeowner for the package. This will enable code-ownership of many packages which currently don't have an owner, and will allow us to validate the owners in a "soft" way by leveraging the codeowners validation that Github provides. The values of these "owner" fields were based on the existing codeowner entries, text-based owner values in package.json files, and in a few cases the package id.
- node scripts/generate package will interactively ask for an owner if it's not supplied on the command line. The owner is then validated and suggestions are provided when the value isn't an actual team in the @elastic org.
- At this time, in order to specify a non-team owner users must pass the owner via --owner CLI flag
This PR moves the kibana.devOnly flag from the package.json file to the kibana.jsonc file. This field determines if the package should be in the deps or devDeps, and whether the package can import devDeps or not. This field is now feeding into the eslint config properly and doing import checking in places which were previously broken. These fixes led to the following packages being moved to "devOnly":
- @kbn/apm-synthtrace
- @kbn/eslint-plugin-disable
- @kbn/eslint-plugin-imports
- @kbn/kibana-manifest-schema

flash1293

VisEditors additions LGTM

…a-packages-manifest

gbamparop · 2022-09-07T16:39:35Z

+packages/kbn-react-field @elastic/kibana-app-services
+packages/kbn-repo-source-classifier @elastic/kibana-operations
+packages/kbn-repo-source-classifier-cli @elastic/kibana-operations
+packages/kbn-rule-data-utils @elastic/apm-ui


Should we be the only code owners here? cc @dgieselaar

Probably all of Obs + Security.

nreese

kibana-gis changes LGTM

…a-packages-manifest

jbudz

I tested the three generate cli commands, manually verified package.json in the build, and that kibana.jsonc was removed.

Maybe in the future we'll have to add an offline flag to node scripts/generate, but not worried about it atm.

…a-packages-manifest

spalger · 2022-09-08T04:39:06Z

@jbudz Updated in 287225e (#138965)

…-fix'

tylersmalley

LGTM - tested.

walterra

ML team related changes LGTM, also checked CODEOWNERS.

azasypkin

Kibana Security related changes LGTM (including the ones in CODEOWNERS).

spalger · 2022-09-08T19:25:13Z

Alright, we have approvals from the vast majority of folks so I'm going to merge this once CI passes unless someone objects in that time.

kibana-ci · 2022-09-08T20:31:50Z

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/kibana-manifest-parser`	4	-	-4
`@kbn/kibana-manifest-schema`	91	96	+5
total			+1

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`@kbn/kibana-manifest-parser`	3	-	-3

Unknown metric groups

API count

id	before	after	diff
`@kbn/kibana-manifest-parser`	7	-	-7
`@kbn/kibana-manifest-schema`	91	97	+6
total			-1

ESLint disabled in files

id	before	after	diff
`@kbn/bazel-packages`	0	1	+1
`@kbn/jsonc`	1	-	-1
total			-0

ESLint disabled line counts

id	before	after	diff
`@kbn/ui-shared-deps-npm`	0	1	+1
`lens`	27	25	-2
total			-1

Total ESLint disabled count

id	before	after	diff
`@kbn/bazel-packages`	0	1	+1
`@kbn/jsonc`	1	-	-1
`@kbn/ui-shared-deps-npm`	0	1	+1
`lens`	30	28	-2
total			-1

History

💚 Build #70296 succeeded 11eef1b
💚 Build #70205 succeeded 12556ab
💚 Build #70178 succeeded 989e029
💚 Build #70122 succeeded 221faa9
💚 Build #69918 succeeded 60ec59d
💚 Build #69840 succeeded 25962a1f53a31599e641f19df49a3b1f5262cb87

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* [packages] add kibana.jsonc files * auto-migrate to kibana.jsonc * support interactive pkg id selection too * remove old codeowners entry * skip codeowners generation when .github/CODEOWNERS doesn't exist * fall back to format validation if user is offline * update question style * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

As best I can tell this was default assigned to operations during a large refactor - #138965. Operations is mostly disconnected from the UI. I'm proposing transferring this over to area teams where flot is in use - stack monitoring, canvas, and timelion.

spalger force-pushed the implement/kibana-packages-manifest branch 15 times, most recently from 2101788 to 5b04812 Compare August 24, 2022 17:02

mistic reviewed Aug 25, 2022

View reviewed changes

Comment thread scripts/kibana_jsonc_migration.js Outdated

spalger force-pushed the implement/kibana-packages-manifest branch 3 times, most recently from 25962a1 to 7348364 Compare September 7, 2022 04:04

spalger added 2 commits September 6, 2022 23:07

[packages] add kibana.jsonc files

0404268

auto-migrate to kibana.jsonc

60ec59d

spalger force-pushed the implement/kibana-packages-manifest branch from 7348364 to 60ec59d Compare September 7, 2022 04:08

spalger added Team:Operations Kibana-Operations Team release_note:skip Skip the PR/issue when compiling release notes labels Sep 7, 2022

spalger marked this pull request as ready for review September 7, 2022 13:42

spalger requested review from a team September 7, 2022 13:42

spalger requested review from a team as code owners September 7, 2022 13:42

flash1293 approved these changes Sep 7, 2022

View reviewed changes

gbamparop reviewed Sep 7, 2022

View reviewed changes

Comment thread .github/CODEOWNERS Outdated

spalger added 2 commits September 7, 2022 11:35

Merge branch 'main' of github.com:elastic/kibana into implement/kiban…

025c2d0

…a-packages-manifest

remove old codeowners entry

989e029

gbamparop reviewed Sep 7, 2022

View reviewed changes

jbudz reviewed Sep 7, 2022

View reviewed changes

Comment thread .buildkite/scripts/steps/checks/bazel_packages.sh

nreese approved these changes Sep 7, 2022

View reviewed changes

spalger added 2 commits September 7, 2022 12:49

Merge branch 'main' of github.com:elastic/kibana into implement/kiban…

a8607c9

…a-packages-manifest

skip codeowners generation when .github/CODEOWNERS doesn't exist

12556ab

jbudz approved these changes Sep 7, 2022

View reviewed changes

spalger added 2 commits September 7, 2022 23:28

Merge branch 'main' of github.com:elastic/kibana into implement/kiban…

23e998a

…a-packages-manifest

fall back to format validation if user is offline

287225e

spalger and others added 2 commits September 7, 2022 23:40

update question style

a4c69b3

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

11eef1b

…-fix'

tylersmalley reviewed Sep 8, 2022

View reviewed changes

walterra approved these changes Sep 8, 2022

View reviewed changes

azasypkin approved these changes Sep 8, 2022

View reviewed changes

Merge branch 'main' into implement/kibana-packages-manifest

ddceeb4

spalger merged commit 3249146 into elastic:main Sep 8, 2022

spalger deleted the implement/kibana-packages-manifest branch September 8, 2022 20:31

kibanamachine added v8.5.0 backport:skip This PR does not require backporting labels Sep 8, 2022

afharo mentioned this pull request Oct 13, 2022

[IDP] Assign appropriate type to the packages. #143264

Open

jbudz mentioned this pull request Sep 18, 2024

Update kbn-flot-charts codeowners #193351

Merged

Conversation

spalger commented Aug 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Reviewers ⚠️

Uh oh!

Uh oh!

flash1293 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gbamparop Sep 7, 2022

Choose a reason for hiding this comment

Uh oh!

sorenlouv Sep 7, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nreese left a comment

Choose a reason for hiding this comment

Uh oh!

jbudz left a comment

Choose a reason for hiding this comment

Uh oh!

spalger commented Sep 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tylersmalley left a comment

Choose a reason for hiding this comment

Uh oh!

walterra left a comment

Choose a reason for hiding this comment

Uh oh!

azasypkin left a comment

Choose a reason for hiding this comment

Uh oh!

spalger commented Sep 8, 2022

Uh oh!

kibana-ci commented Sep 8, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Public APIs missing exports

API count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

15 participants

spalger commented Aug 17, 2022 •

edited

Loading

spalger commented Sep 8, 2022 •

edited

Loading