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(profiles/w3c-common): freeze profile to v25.5.0 #2838

Merged
merged 3 commits into from
Apr 15, 2020

Conversation

sidvishnoi
Copy link
Member

@sidvishnoi sidvishnoi commented Apr 15, 2020

🚨 We would no longer be updating w3c-common profile. 🚨
The profile will continue to be hosted at https://www.w3.org/Tools/respec/respec-w3c-common


Why?

It exposes some of ReSpec's internals, so we can't safely make changes to our internal structure and move forward. A lot of legacy specs use those internals, so we can't just remove them.
The most recent incident which triggered this decision is the breaking of https://w3c.github.io/json-ld-syntax/, which makes use of local-linking portion of core/link-to-dfn. [json-ld-syntax] broke as it wanted to hook between end of local-linking and start of external-linking - which we do not expose anymore.

How can we extend ReSpec now?

Presently, there is no way to do it. Not breaking specs is our priority. We do have plans to provide extensibility in future.
If you've a use case that other specs can also use, consider opening an issue/sending a PR so everyone can benefit from it!

Want new features and bug fixes?

Use the respec-w3c profile. It is nearly 90KB (30KB gzip) smaller than respec-w3c-common.
Most of specs need to simply replace:
https://www.w3.org/Tools/respec/respec-w3c-common with
https://www.w3.org/Tools/respec/respec-w3c

TODO:

@sidvishnoi sidvishnoi requested review from marcoscaceres, samuelweiler and saschanaz and removed request for samuelweiler April 15, 2020 10:45
Copy link
Contributor

@marcoscaceres marcoscaceres left a comment

Choose a reason for hiding this comment

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

I think this is a good idea.

Copy link
Collaborator

@saschanaz saschanaz left a comment

Choose a reason for hiding this comment

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

LGTM, although I hope specs use npm and CI to prevent breakage rather than current situation 🤔

@sidvishnoi
Copy link
Member Author

Maybe we should revisit https://github.com/w3c/respec/pull/2702

@sidvishnoi sidvishnoi merged commit c8660a0 into develop Apr 15, 2020
@sidvishnoi sidvishnoi deleted the freeze-w3c-with-jquery branch April 15, 2020 13:23
xfq referenced this pull request in w3c/jlreq Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/ltli Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/miniapp Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/simple-ruby Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/string-meta Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in xfq/mongolian-gb Jul 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
himorin referenced this pull request in himorin/jlreq Jul 16, 2020
xfq referenced this pull request in w3c/klreq Aug 16, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/i18n-activity Aug 17, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/hlreq Aug 20, 2020
The w3c-common profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/alreq Aug 22, 2020
The w3c-common profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
xfq referenced this pull request in w3c/klreq Aug 27, 2020
The `w3c-common` profile was no longer updated.
See https://github.com/w3c/respec/pull/2838 for details.
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