Skip to content

move flexsuite security recipe to category subfolder - #1341

Merged
rezrah merged 3 commits into
mainfrom
rezrah/recategorize-flexsuite-recipe
May 5, 2026
Merged

move flexsuite security recipe to category subfolder#1341
rezrah merged 3 commits into
mainfrom
rezrah/recategorize-flexsuite-recipe

Conversation

@rezrah

@rezrah rezrah commented May 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Towards https://github.com/github/brand-marketing-design/issues/2606

Moves the security recipe to a new catgory template folder. It was incorrectly considered an overview template before.

List of notable changes:

  • Moves security recipe to a new subfolder

Steps to test:

  1. Verify this story appears under recipes/flexsuite/category/security now

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • UI Changes contain new visual snapshots (generated by adding update snapshots label to the PR)
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Screenshots:

Please try to provide before and after screenshots or videos

Before After

Copilot AI review requested due to automatic review settings May 1, 2026 11:50
@rezrah
rezrah requested a review from a team as a code owner May 1, 2026 11:50
@changeset-bot

changeset-bot Bot commented May 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cb678ad

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 commented May 1, 2026

Copy link
Copy Markdown
Contributor

🟢 No design token changes found

@rezrah
rezrah temporarily deployed to github-pages May 1, 2026 11:54 — with GitHub Actions Inactive
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown
Contributor

🟢 No unit test coverage changes found

All components and hooks with tests maintain the same coverage as the main branch.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Moves the Flexsuite Security recipe out of the “Overview” recipe group and into a new “Category” recipe group, aligning Storybook organization and e2e/visual test coverage with the intended template classification.

Changes:

  • Removed the Security overview Storybook story and visual snapshot coverage from recipes/FlexSuite/Overview.
  • Added a new recipes/FlexSuite/Category Security recipe (component, content, and Storybook story).
  • Updated Playwright visual-test generation timing and axe delay mappings to target the new Storybook story id, plus updated i18n strings.
Show a summary per file
File Description
packages/react/src/recipes/Flexsuite/Overview/index.ts Stops exporting the removed Security overview entry.
packages/react/src/recipes/Flexsuite/Overview/Overview.visual.spec.ts Removes the Security overview visual regression test case.
packages/react/src/recipes/Flexsuite/Overview/FlexSuiteSecurityOverview.stories.tsx Removes the old Security overview Storybook story.
packages/react/src/recipes/Flexsuite/Category/index.ts Adds barrel export for the new Security category recipe.
packages/react/src/recipes/Flexsuite/Category/FlexSuiteSecurityCategory.tsx Introduces the new Security category recipe component/template.
packages/react/src/recipes/Flexsuite/Category/FlexSuiteSecurityCategory.stories.tsx Adds Storybook story under Recipes/FlexSuite/Category with id recipes-flexsuite-category--security.
packages/react/src/recipes/Flexsuite/Category/FlexSuiteSecurityCategory.content.ts Adds/renames content model + localized content getter for the new category recipe.
packages/react/src/recipes/Flexsuite/Category/Category.visual.spec.ts Adds visual regression coverage for the new Category story (but currently includes an unrelated SEO story too).
packages/e2e/scripts/playwright/playwright.generate-tests.ts Updates the per-story timeout lookup key to the new Storybook id.
packages/e2e/scripts/playwright/axe-clean.spec.ts Updates custom axe delay mapping to the new Storybook id.
apps/storybook/static/locales/*/FlexSuiteSecurityCategory.json Updates localized strings referencing “overview” → “category”.

Copilot's findings

  • Files reviewed: 16/17 changed files
  • Comments generated: 1

Comment thread packages/react/src/recipes/Flexsuite/Category/Category.visual.spec.ts Outdated
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown
Contributor

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

@rezrah
rezrah temporarily deployed to github-pages May 1, 2026 13:08 — with GitHub Actions Inactive
Comment thread apps/storybook/debug-storybook.log Outdated

@danielguillan danielguillan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good. We just need to remove the log file that was committed by mistake.

@rezrah
rezrah temporarily deployed to github-pages May 5, 2026 11:48 — with GitHub Actions Inactive
@rezrah
rezrah merged commit 74db366 into main May 5, 2026
14 checks passed
@rezrah
rezrah deleted the rezrah/recategorize-flexsuite-recipe branch May 5, 2026 12:27
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