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

docs: update typing guidelines #1881

Conversation

david-luna
Copy link
Contributor

Which problem is this PR solving?

This PR showcases the use of generic types when exporting types to the public API that depend on the instrumented package.

The generic types approach seeks to avoid adding a types package as a dependency of the instrumentation because it may bring some problems to consumers like #1787

This approach has been added as a replacement of the any type approach since its the fallback type when using a generic

Short description of the changes

  • update guildelines doc

@david-luna david-luna requested a review from a team December 27, 2023 11:02
Copy link

codecov bot commented Dec 27, 2023

Codecov Report

Merging #1881 (a673543) into main (cf57292) will not change coverage.
The diff coverage is n/a.

❗ Current head a673543 differs from pull request most recent head ceb8aa2. Consider uploading reports for the commit ceb8aa2 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1881   +/-   ##
=======================================
  Coverage   91.45%   91.45%           
=======================================
  Files         144      144           
  Lines        7406     7406           
  Branches     1483     1483           
=======================================
  Hits         6773     6773           
  Misses        633      633           

david-luna and others added 17 commits December 27, 2023 12:19
Bumps [axios](https://github.com/axios/axios) from 0.21.4 to 1.6.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](axios/axios@v0.21.4...v1.6.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…(security) (open-telemetry#1868)

* chore: bump system info version to address arbitrary command injection vulnerability in systeminformation

Signed-off-by: yyomba <[email protected]>

* chore: sync package-lock.json

---------

Signed-off-by: yyomba <[email protected]>
Co-authored-by: Marc Pichler <[email protected]>
we may want information but still never stale it
so set exempt label first for early return.
any-of-label is comma-separated allowlist.
remove instr-request and bug to avoid needing to remove labels.

Co-authored-by: Marc Pichler <[email protected]>
)

This is as a workaround for ESM testing failing with v18.19.0 due
to node's off-thread ESM loading and import-in-the-middle's limitation
with reexports.

Refs: open-telemetry#1872
* fix(deps): update opentelemetry-js monorepo

* fix(deps): update otel core experimental to ^0.46.0

* fix: re-generate package-lock.json

* fix: test with updated import-in-the-middle hook

* fix: use type-compatible versions of rxjs

* fix(mongodb-example): remove unneeded useUnifiedTopology parameter

* fix: remove iitm 1.7.2 again, use otel hook (iitm 1.7.1)

---------

Co-authored-by: Mend Renovate <[email protected]>
* added maintainer for the react plugin

* Update .github/component_owners.yml

---------

Co-authored-by: Marc Pichler <[email protected]>
@david-luna
Copy link
Contributor Author

dont know how the other commits got it. Going to recreate the PR

@david-luna david-luna closed this Dec 27, 2023
@david-luna david-luna deleted the dluna/update-contrib-guidelines-for-types branch December 27, 2023 11:44
@blumamir
Copy link
Member

I think it's a great workaround for the breaking type issue and a welcome addition to the guidelines.
would love to approve when you reopen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants