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

ci: automation to cut release automatically when core one is done to keep versions in sync #457

Closed
vmarchaud opened this issue Apr 26, 2021 · 5 comments
Labels
discussion internal stale up-for-grabs Good for taking. Extra help will be provided by maintainers

Comments

@vmarchaud
Copy link
Member

Based on #448. We need to answer different questions before implementing this:

  • if a release is cut for contrib but not for core, do we sync it to core ? Generally does it works both way ?
  • what if breaking changes happens ? we could make an automatic PR but this would still require human to fix it, since contrib have 3rd party code, how do we handle this ?
@vmarchaud vmarchaud added discussion up-for-grabs Good for taking. Extra help will be provided by maintainers internal labels Apr 26, 2021
@obecny
Copy link
Member

obecny commented Apr 26, 2021

well it will de sync sooner or later, once we release 1.0 it might be in sync for a while, but later there is a chance it will desync anyway. I would not be worry about it, these are 2 repos anyway.

@dyladan
Copy link
Member

dyladan commented Apr 26, 2021

If we don't sync them, we at least need a way to make it immediately obvious which versions are compatible without having to check some readme.

1 possible solution is to peer depend on API. If we peer depend on the compatible API version, it will complain at install time if the API version the user installed is incompatible. Since the instrumentations only use the API and don't interact directly with SDK, this should be fine.

This is basically the same reason we decided to do this for core, and i've seen other "in the wild" plugins and instrumentations do it this way too.

@lizthegrey
Copy link
Member

If we don't sync them, we at least need a way to make it immediately obvious which versions are compatible without having to check some readme.

1 possible solution is to peer depend on API. If we peer depend on the compatible API version, it will complain at install time if the API version the user installed is incompatible. Since the instrumentations only use the API and don't interact directly with SDK, this should be fine.

This is basically the same reason we decided to do this for core, and i've seen other "in the wild" plugins and instrumentations do it this way too.

+1 that peerDependencies are the right way to warn on this.

@github-actions
Copy link
Contributor

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale label Nov 29, 2021
@vmarchaud
Copy link
Member Author

I'll go ahead and close this, we implemented a while ago peerDependency on the api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion internal stale up-for-grabs Good for taking. Extra help will be provided by maintainers
Projects
None yet
Development

No branches or pull requests

4 participants