Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(NA): creates pkg_npm_types bazel rule #116465

Merged
merged 52 commits into from
Nov 16, 2021

Conversation

mistic
Copy link
Member

@mistic mistic commented Oct 27, 2021

This PR creates a pkg_npm_types bazel rule that allow us to create summarised version of the public types for each package as well as move forward with the separation of code and types modules for each package as discussed and commented at #107648 (comment)

With the push of this work forward is worth to mention that we will loose the ability to point and click into source on every package that migrates into that new rule. In order to recover that feature we need to work on microsoft/rushstack#1886 (comment) so we can bring sourcemaps into the api-extractor tool.

@mistic mistic added chore Team:Operations Team label for Operations Team v8.0.0 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed v8.1.0 v7.16.1 labels Oct 27, 2021
@mistic mistic requested a review from tylersmalley October 27, 2021 15:25
@mistic

This comment has been minimized.

@mistic

This comment has been minimized.

@mistic

This comment has been minimized.

@mistic

This comment has been minimized.

Copy link
Contributor

@tylersmalley tylersmalley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mistic

This comment has been minimized.

@kibanamachine

This comment has been minimized.

@elastic elastic deleted a comment from kibanamachine Nov 12, 2021
@@ -0,0 +1,8 @@
{
"name": "{{{NAME}}}",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

~/dev/kibana/node_modules/@types/elastic__datemath(pr/116465*) » cat package.json                                                                                                                          jon@xps
{
  "name": "@types/elastic__datemath",
  "description": "Generated by Bazel",
  "types": "./index.d.ts",
  "private": true,
  "license": "MIT",
  "version": "1.1.0"
}

Should license/version match the package's settings?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a placeholder and those packages won't be published, I believe we can ignore those 😃

@mistic

This comment has been minimized.

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Test Failures

  • [job] [logs] Default CI Group #4 / Spaces app Spaces Space Selector allows user to navigate to different spaces

Metrics [docs]

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
kibana 894 895 +1

History

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

@mistic mistic merged commit 5fe8d74 into elastic:main Nov 16, 2021
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Nov 16, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Nov 16, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
8.0
7.16

The backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Nov 16, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>

Co-authored-by: Tiago Costa <[email protected]>
kibanamachine added a commit that referenced this pull request Nov 16, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>

Co-authored-by: Tiago Costa <[email protected]>
jloleysens added a commit to jloleysens/kibana that referenced this pull request Nov 16, 2021
…igrate-away-from-injected-css-js

* 'main' of github.com:elastic/kibana: (221 commits)
  [Reporting] Add log level to config (elastic#118319)
  [Metrics UI] Skip failing waffle chart color palette test (elastic#118527)
  [APM] chore: Unify naming of 'apm/scripts/**/*' with snake_case (elastic#118328)
  skip flaky suites (elastic#99581, elastic#118356, elastic#118474)
  [Alerting] Initial implementation of alerting task `cancel()` (elastic#114289)
  chore(NA): creates pkg_npm_types bazel rule (elastic#116465)
  skip flaky suite (elastic#116892)
  Bump chromedriver to 95.0.0 (elastic#116724)
  [Data visualizer] Improve design of expanded rows (elastic#118125)
  [APM] prefer ECS field names for HTTP and URL (elastic#118485)
  Update query_debugging_in_development_and_production.md (elastic#118491)
  [Uptime] adjust Elastic Synthetics integration functional tests (elastic#118163)
  [kbn/rule-data-utils] add submodules and require public use them (elastic#117963)
  [DOCS] Refresh APM correlation screenshots (elastic#116723) (elastic#118577)
  Handles ns to ms conversion for event loop delay metrics (elastic#118447)
  [Cases] Rename functional tests folder (elastic#118490)
  dummy commit
  skip flaky suite (elastic#118593)
  Improve workpad schema validation (elastic#97838)
  skip flaky suite (elastic#118584)
  ...

# Conflicts:
#	src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx
mbondyra pushed a commit to mbondyra/kibana that referenced this pull request Nov 19, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>
dmlemeshko pushed a commit that referenced this pull request Nov 29, 2021
* chore(NA): auto creation of the package.json for the new types pkg rule

* chore(NA): first alpha api extractor working version

* chore(NA): support kbn-analytics

* chore(NA): correctly read tsconfig files and deps from ts_config rule

* chore(NA): layed out pkg_npm_types tree artifact custom rule

* chore(NA): missing todos

* chore(NA): node modules link mapping

* chore(NA): fully working pkg_npm_types rule

* chore(NA): fix changes on new packages using elastic datemath pkgs

* docs(NA): remove todo

* docs(NA): last todo text correction

* chore(NA): removed commented lines

* fix(NA): include missing package version

* chore(NA): include license keys

* chore(NA): change mock types package into private

* chore(NA): disable validator on ts_project rule

* chore(NA): use the wrapper for ts_project

* commit using @elastic.co

* chore(NA): commit using @elastic.co

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed chore release_note:skip Skip the PR/issue when compiling release notes Team:Operations Team label for Operations Team v7.16.1 v8.0.0 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants