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

Adds data for hooks APIs #5554

Merged
merged 2 commits into from
Jan 16, 2025
Merged

Adds data for hooks APIs #5554

merged 2 commits into from
Jan 16, 2025

Conversation

mperrotti
Copy link
Contributor

@mperrotti mperrotti commented Jan 16, 2025

Relates to https://github.com/github/primer/issues/2986

See https://github.com/github/primer-docs/pull/206 for an example of how this will be used.

Changelog

None of the work in this PR includes user-facing changes except for a new generated JSON file with all the hooks APIs' data. Do we need a changelog for this PR?

New

Generates a JSON file with hooks APIs' data in generated/.

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

To test, run npm run build:hooks.json and confirm that there are no errors.

To review:

  • The overall approach
  • packages/react/script/hooks-json/build.ts
  • Accuracy of the docs

Merge checklist

… JSON file for all hooks

adds hooks build to 'build-components-json' in CI
@mperrotti mperrotti requested a review from a team as a code owner January 16, 2025 02:48
@mperrotti mperrotti requested a review from joshblack January 16, 2025 02:48
Copy link

changeset-bot bot commented Jan 16, 2025

⚠️ No Changeset found

Latest commit: a7d10e7

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

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Jan 16, 2025
Copy link
Contributor

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

@github-actions github-actions bot temporarily deployed to storybook-preview-5554 January 16, 2025 02:50 Inactive
Copy link
Contributor

github-actions bot commented Jan 16, 2025

size-limit report 📦

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

@joshblack
Copy link
Member

You're good to just have this as "none" with no changeset, I think 👍

@mperrotti mperrotti added the skip changeset This change does not need a changelog label Jan 16, 2025
@mperrotti mperrotti enabled auto-merge January 16, 2025 21:26
@mperrotti mperrotti added this pull request to the merge queue Jan 16, 2025
Merged via the queue into main with commit d25d35c Jan 16, 2025
41 of 42 checks passed
@mperrotti mperrotti deleted the mp/hooks-docs-data branch January 16, 2025 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants