Skip to content

chore: create storybook build on PR #613

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Apr 29, 2025

Description

This PR adds two new GitHub Actions workflows for handling Storybook builds and deployments:

  1. build-storybook-main.yml: Handles building and deploying Storybook to GitHub Pages for the main branch

    • Uses GitHub Pages for hosting the main branch's Storybook
    • Includes dependency installation and build steps
    • Deploys using the peaceiris/actions-gh-pages action
  2. build-storybook-pr.yml: Handles building Storybook for PRs

    • Builds Storybook for review purposes
    • Includes S3 upload capability for PR builds when AWS credentials are configured
    • Uses MetaMask's secure checkout practices

Related issues

Fixes: #4

Manual testing steps

  1. Create a PR to test the PR workflow
  2. Verify Storybook builds successfully
  3. Once merged to main, verify deployment to GitHub Pages
  4. Check that the working directory path (apps/storybook-react) is correct
  5. Verify GitHub Pages environment is properly configured

Screenshots/Recordings

Not applicable for workflow changes.

Before

N/A

After

N/A

Pre-merge author checklist

  • I've followed MetaMask Contributor Docs
  • I've completed the PR template to the best of my ability
  • I've included tests if applicable
  • I've documented my code using JSDoc format if applicable
  • I've applied the right labels on the PR

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@georgewrmarshall georgewrmarshall force-pushed the fix/4/storybook-pr-build branch from 64b4c28 to b1ad079 Compare April 29, 2025 03:43
@georgewrmarshall georgewrmarshall force-pushed the fix/4/storybook-pr-build branch from b1ad079 to a6e274e Compare April 29, 2025 03:44
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.

react: Automate Storybook Build for Successful PRs in metamask-design-system via GitHub Actions
1 participant