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

test: add check for story ids in generated docs #5441

Merged
merged 16 commits into from
Jan 3, 2025

Conversation

joshblack
Copy link
Member

@joshblack joshblack commented Dec 13, 2024

Closes https://github.com/github/primer/issues/3632

With these changes, CI will fail if a *.docs.json story is not a valid storybook story ID, preventing broken stories on production docs.
Sample error:
error log on broken story id for hidden component

Changelog

New

  • CI step to build storybook and test again generated story IDs in *.docs.json
  • Added logic to check for valid story IDs in generated docs to components-json/build script

Changed

  • Updated storybook build script
  • Updated broken IconButton story ID (the action is working!)
  • Updated broken Hidden story ID (the action is working!)
  • Updated broken InlineMessage story ID (the action is working!)
  • Updated broken Portal story ID (the action is working!)
  • Updated broken TooltipV2 story ID (the action is working!)

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

Copy link

changeset-bot bot commented Dec 13, 2024

🦋 Changeset detected

Latest commit: 134b3d1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added staff Author is a staff member integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Dec 13, 2024
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!

@joshblack joshblack added skip changeset This change does not need a changelog and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Dec 13, 2024
@github-actions github-actions bot temporarily deployed to storybook-preview-5441 December 13, 2024 20:17 Inactive
Copy link
Contributor

github-actions bot commented Dec 13, 2024

size-limit report 📦

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

@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 Dec 27, 2024
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!

Copy link
Contributor

Uh oh! @joshblack, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

@github-actions github-actions bot temporarily deployed to storybook-preview-5441 December 27, 2024 21:19 Inactive
@francinelucca francinelucca marked this pull request as ready for review December 27, 2024 21:30
@francinelucca francinelucca requested a review from a team as a code owner December 27, 2024 21:30
@francinelucca francinelucca added this pull request to the merge queue Jan 2, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 2, 2025
@github-actions github-actions bot temporarily deployed to storybook-preview-5441 January 2, 2025 18:36 Inactive
@primer primer bot requested a review from a team as a code owner January 2, 2025 19:17
@primer primer bot requested a review from emilybrick January 2, 2025 19:17
@primer primer bot temporarily deployed to github-pages January 2, 2025 19:19 Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-5441 January 2, 2025 19:19 Inactive
@TylerJDev TylerJDev mentioned this pull request Jan 2, 2025
13 tasks
@github-actions github-actions bot temporarily deployed to storybook-preview-5441 January 3, 2025 18:04 Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-5441 January 3, 2025 18:10 Inactive
@francinelucca francinelucca force-pushed the test/add-check-for-story-ids branch from 7879d45 to 949f52f Compare January 3, 2025 18:11
@francinelucca francinelucca added this pull request to the merge queue Jan 3, 2025
Merged via the queue into main with commit 30e8c31 Jan 3, 2025
42 checks passed
@francinelucca francinelucca deleted the test/add-check-for-story-ids branch January 3, 2025 18:42
@primer primer bot mentioned this pull request Jan 3, 2025
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 staff Author is a staff member status: review needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants