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(docs): Add importPath to docs.json #4461

Merged
merged 3 commits into from
Apr 5, 2024
Merged

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Apr 3, 2024

Having a new next entry point made the current auto generated component import path in primer.style invalid for next components such as tooltip. Discussed this with @camertron and instead of generating the import path based on the component status, we are thinking to make this as a field on the component.docs.json since it is the single source of truth of component artefacts.

For now, I only added to the tooltip docs.json files but the intention it to make it required and add it to each docs.json file if I have the consensus. Please let me know if you have any concern with this approach and/or if you have any suggestions
I got some thumbs up so I updated all 🔥

Changelog

New

Changed

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
Copy link

changeset-bot bot commented Apr 3, 2024

⚠️ No Changeset found

Latest commit: 4078857

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Apr 3, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 88.01 KB (0%)
packages/react/dist/browser.umd.js 88.41 KB (0%)

@broccolinisoup broccolinisoup marked this pull request as ready for review April 3, 2024 23:46
@broccolinisoup broccolinisoup requested a review from a team as a code owner April 3, 2024 23:46
@broccolinisoup broccolinisoup requested a review from keithamus April 3, 2024 23:46
@github-actions github-actions bot temporarily deployed to storybook-preview-4461 April 3, 2024 23:46 Inactive
@broccolinisoup broccolinisoup added the skip changeset This change does not need a changelog label Apr 4, 2024

Verified

This commit was signed with the committer’s verified signature. The key has expired.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
@broccolinisoup broccolinisoup changed the title add importPath to docs.json chrore(docs): Add importPath to docs.json Apr 5, 2024
@broccolinisoup broccolinisoup changed the title chrore(docs): Add importPath to docs.json chore(docs): Add importPath to docs.json Apr 5, 2024
@broccolinisoup broccolinisoup added this pull request to the merge queue Apr 5, 2024
Merged via the queue into main with commit 5993c05 Apr 5, 2024
33 checks passed
@broccolinisoup broccolinisoup deleted the docs-json-import-path branch April 5, 2024 01:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants