Skip to content

Enforce stronger checks on SO type definition changes#227636

Merged
gsoldevila merged 2 commits intoelastic:mainfrom
gsoldevila:stronger-checks-on-so-types
Jul 14, 2025
Merged

Enforce stronger checks on SO type definition changes#227636
gsoldevila merged 2 commits intoelastic:mainfrom
gsoldevila:stronger-checks-on-so-types

Conversation

@gsoldevila
Copy link
Copy Markdown
Member

@gsoldevila gsoldevila commented Jul 11, 2025

Summary

Closes https://github.com/elastic/kibana-team/issues/1746
Closes https://github.com/elastic/kibana-team/issues/1801
Addresses https://elasticco.atlassian.net/browse/APEX-91

As codeowners of the check_registered_types.test.ts, @elastic/kibana-core was already pinged whenever SO types had modifications.

This PR aims at putting in place much clearer checks to control which changes are being performed in the registered SO types. For each of the updated snapshots, a description is added on top, with a checklist of things that are and are NOT allowed when upgrading SO definitions.

The PR also improves a couple of other things:

  • checking that folks don't skip any version number when defining modelVersions.
  • checking mutations on migrations and modelVersions that use a provider function.

@gsoldevila gsoldevila requested a review from a team as a code owner July 11, 2025 12:18
@gsoldevila gsoldevila added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Jul 11, 2025
@gsoldevila gsoldevila enabled auto-merge (squash) July 14, 2025 09:58
@gsoldevila gsoldevila merged commit 74ca9a1 into elastic:main Jul 14, 2025
11 of 12 checks passed
@elasticmachine
Copy link
Copy Markdown
Contributor

💚 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/core-test-helpers-so-type-serializer 14 16 +2
Unknown metric groups

API count

id before after diff
@kbn/core-test-helpers-so-type-serializer 15 17 +2

ESLint disabled line counts

id before after diff
@kbn/core-test-helpers-so-type-serializer 1 6 +5

References to deprecated APIs

id before after diff
@kbn/core 633 637 +4

Total ESLint disabled count

id before after diff
@kbn/core-test-helpers-so-type-serializer 1 6 +5

History

Bluefinger pushed a commit to Bluefinger/kibana that referenced this pull request Jul 22, 2025
## Summary

Closes elastic/kibana-team#1746
Closes elastic/kibana-team#1801
Addresses https://elasticco.atlassian.net/browse/APEX-91

As codeowners of the `check_registered_types.test.ts`,
@elastic/kibana-core was already pinged whenever SO types had
modifications.

This PR aims at putting in place much clearer checks to control which
changes are being performed in the registered SO types. For each of the
updated snapshots, a description is added on top, with a checklist of
things that are and are NOT allowed when upgrading SO definitions.

The PR also improves a couple of other things:
- checking that folks don't skip any version number when defining
_modelVersions_.
- checking mutations on _migrations_ and _modelVersions_ that use a
provider function.
kertal pushed a commit to kertal/kibana that referenced this pull request Jul 25, 2025
## Summary

Closes elastic/kibana-team#1746
Closes elastic/kibana-team#1801
Addresses https://elasticco.atlassian.net/browse/APEX-91

As codeowners of the `check_registered_types.test.ts`,
@elastic/kibana-core was already pinged whenever SO types had
modifications.

This PR aims at putting in place much clearer checks to control which
changes are being performed in the registered SO types. For each of the
updated snapshots, a description is added on top, with a checklist of
things that are and are NOT allowed when upgrading SO definitions.

The PR also improves a couple of other things:
- checking that folks don't skip any version number when defining
_modelVersions_.
- checking mutations on _migrations_ and _modelVersions_ that use a
provider function.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants