Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Update Storybook stories to use Component Story Format: client/web/enterprise/batches/* - batch-spec, list, preview #36770

Open
gitstart-sourcegraph opened this issue Jun 8, 2022 · 2 comments
Assignees
Labels
gitstart Contract partner

Comments

@gitstart-sourcegraph
Copy link
Collaborator

gitstart-sourcegraph commented Jun 8, 2022

Problem statement

The Component Story Format is the recommended way to write stories in Storybook. The new format is easier to understand and it is also important that we update our existing stories to ensure we stay up to date with new features, and are able to follow future documentation.

Check out this Sourcegraph search result to view these stories.

Success criteria

  • All stories in the repo are using the Component Story Format
  • All stories still usable when running yarn storybook

Implementation details

Please see this PR description as an example of how this change can be implemented.

In summary, follow these implementation steps:

  1. Modify existing storiesOf usage to ensure any add or alternative function calls are chained onto the original storiesOf function call. See this diff for an example of this change: https://github.com/sourcegraph/sourcegraph/pull/25222/commits/e3a39cae40c69cb74de1d0461bd70fb31bdb281a
  2. Run the storiesof-to-csf Storybook codemod with this command: npx sb migrate storiesof-to-csf --glob="client/web/**/*.story.tsx". For an expected diff (on different files) see this commit: https://github.com/sourcegraph/sourcegraph/commit/5a5b716337da4a768b4b26157d06728035c57816
  3. Run the csf-hoist-story-annotations Storybook codemod with this command: npx sb migrate csf-hoist-story-annotations --glob="client/web/**/*.story.tsx". For an expected diff (on different files) see this commit: https://github.com/sourcegraph/sourcegraph/commit/b228f5d5879b5164d23565c7d63480793e6004da
  4. You will likely see TypeScript warnings on the newly-modified files. Update these by adding the Storybook types. See this commit for reference: https://github.com/sourcegraph/sourcegraph/commit/810e8e217d6a665f109ca2a0a92ba4125f6b27ea

Ref

https://github.com/sourcegraph/sourcegraph/issues/25227

Directories to be Migrated

  • client/web/src/enterprise/batches/batch-spec
  • client/web/src/enterprise/batches/list
  • client/web/src/enterprise/batches/preview

Time estimate

  • Pull requests with ~450 lines changed should take 3 hours at maximum. Ping the reviewer in the spec pull request if time-consuming changes are required.
  • Split the work into multiple pull requests if the total diff is bigger than 450 lines of code.
@gitstart-sourcegraph gitstart-sourcegraph added the gitstart Contract partner label Jun 8, 2022
@gitstart-sourcegraph gitstart-sourcegraph self-assigned this Jun 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jun 8, 2022

Hey, @sourcegraph/batchers (@eseliger @LawnGnome @courier-new @adeola-ak @BolajiOlajide @Piszmog @malomarrec @chrispine @danielmarquespt) - we have been mentioned. Let's take a look.

@gitstart-sourcegraph gitstart-sourcegraph changed the title Update Storybook stories to use Component Story Format: Update Storybook stories to use Component Story Format: client/web/enterprise/* Jun 8, 2022
@gitstart-app
Copy link
Contributor

gitstart-app bot commented Jun 8, 2022

Here is the GitStart Ticket for this issue: https://app.gitstart.com/clients/sourcegraph/tickets/SG-36770

@gitstart-sourcegraph gitstart-sourcegraph changed the title Update Storybook stories to use Component Story Format: client/web/enterprise/* Update Storybook stories to use Component Story Format: client/web/enterprise/batches/* - batch-spec, list, preview Jun 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
gitstart Contract partner
Projects
None yet
Development

No branches or pull requests

1 participant