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

Development setup for changes effecting API + SDK/Plugins #1947

Open
1 of 2 tasks
Flarna opened this issue Feb 20, 2021 · 2 comments
Open
1 of 2 tasks

Development setup for changes effecting API + SDK/Plugins #1947

Flarna opened this issue Feb 20, 2021 · 2 comments
Labels
Discussion Issue or PR that needs/is extended discussion.

Comments

@Flarna
Copy link
Member

Flarna commented Feb 20, 2021

  • This only affects the JavaScript OpenTelemetry library
  • This may affect other libraries, but I would like to get opinions here first

The development setup for plugins in contrib repo was already quite cumbersome if you want to adapt something to match changes done in core repo before an actual release of core was done.

But now we have even one more indirection as API was moved into a new repo.

Is there a known "easy" setup if someone has the need to add a new API and wants to use it in a plugin hosted in contrib?
I have not tried yet but I fear that the dependencies to packages here - which in turn depend on API - easily result in having two (incompatible) versions of API installed.

I think some (nightly) CI setup to verify that tip latest API main works with latest core main would be nice. One step further would be a CI run to verify latest contrib + latest core + latest API.

@Flarna Flarna added the Discussion Issue or PR that needs/is extended discussion. label Feb 20, 2021
@Flarna
Copy link
Member Author

Flarna commented May 21, 2021

I have just learned that this repo published canaries releases to NPM (e.g. 0.19.1-alpha.33). If something similar is done for API it would allow to use the new API here and adapt. Even further down to contrib would be possible.

This would avoid the need to release API just to have something in hand to adapt core.

see also open-telemetry/opentelemetry-js-api#70 (comment)

@dyladan
Copy link
Member

dyladan commented May 21, 2021

This could actually be helpful right now as currently updating core is blocked on an unreleased API fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Issue or PR that needs/is extended discussion.
Projects
None yet
Development

No branches or pull requests

2 participants