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

fix!: Rename webrtc to webrtc-direct and webrtc-w3c to webrtc #314

Merged
merged 2 commits into from
Mar 17, 2023

Conversation

mxinden
Copy link
Member

@mxinden mxinden commented Mar 9, 2023

We have decided to rename webrtc-w3c to webrtc-private-to-private. See rational in multiformats/multiaddr#150.

No software has been released using webrtc-w3c, thus renaming is not a breaking change. Ignoring the automated multiaddr v11.5.0 release.

See also #309 that introduced webrtc-w3c.

We have decided to rename `webrtc-w3c` to `webrtc-private-to-private`. See
rational in multiformats/multiaddr#150.

No software has been released using `webrtc-w3c`, thus renaming is not a
breaking change. Ignoring the automated `multiaddr` `v11.5.0` release.

See also multiformats#309 that introduced `webrtc-w3c`.
@mxinden
Copy link
Member Author

mxinden commented Mar 9, 2023

No software has been released using webrtc-w3c, thus renaming is not a breaking change. Ignoring the automated multiaddr v11.5.0 release.

@achingbrain is the assumption correct that this does not pose any issues even though there has been an automated release,namely v11.5.0, with webrtc-w3c?

@mxinden
Copy link
Member Author

mxinden commented Mar 13, 2023

Friendly ping @achingbrain, @MarcoPolo and @marten-seemann.

@achingbrain achingbrain changed the title fix: Rename webrtc-w3c to webrtc-private-to-private fix!: Rename webrtc-w3c to webrtc-private-to-private Mar 13, 2023
@achingbrain
Copy link
Member

This is a breaking change so it should go out as such, but the impact should be minimal, just a lot of dependabot PRs to merge.

I will merged this once the upstream change has gone in.

@MarcoPolo
Copy link
Contributor

Are we actually using this anywhere? Why is it a breaking change?

@achingbrain
Copy link
Member

It's breaking because methods that previously accepted "webrtc-w3c" as input or returned it will now accept/return "webrtc-private-to-private" instead.

@MarcoPolo
Copy link
Contributor

Yes, it's technically a breaking change. I see that. Is there anything that is using this that will be affected?

@achingbrain
Copy link
Member

I cannot say yes or no with 100% certainty, so it's generally better to err on the side of caution.

Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

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

In https://github.com/multiformats/multiaddr/pull/152/files we decided that the browser-to-server version would be called webrtc-direct and the browser-to-browser version would just be webrtc

src/protocols-table.ts Outdated Show resolved Hide resolved
src/protocols-table.ts Outdated Show resolved Hide resolved
@achingbrain achingbrain changed the title fix!: Rename webrtc-w3c to webrtc-private-to-private fix!: Rename webrtc-w3c to webrtc and webrtc to webrtc-direct Mar 17, 2023
@achingbrain achingbrain changed the title fix!: Rename webrtc-w3c to webrtc and webrtc to webrtc-direct fix!: Rename webrtc to webrtc-direct and webrtc-w3c to webrtc Mar 17, 2023
@achingbrain achingbrain merged commit fc33ac8 into multiformats:master Mar 17, 2023
github-actions bot pushed a commit that referenced this pull request Mar 17, 2023
## [12.0.0](v11.6.1...v12.0.0) (2023-03-17)

### ⚠ BREAKING CHANGES

* webrtc has been renamed webrtc-direct and webrtc-w3c has been renamed webrtc

### Bug Fixes

* Rename webrtc to webrtc-direct and webrtc-w3c to webrtc ([#314](#314)) ([fc33ac8](fc33ac8))
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.

3 participants