Build and Upload Storybook in Github Workflows #504
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
meisekimiu
requested review from
slifty and
liam-lloyd
and removed request for
slifty
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #504 +/- ##
==========================================
- Coverage 43.22% 43.21% -0.01%
==========================================
Files 363 363
Lines 11102 11102
Branches 1809 1809
==========================================
- Hits 4799 4798 -1
- Misses 6141 6142 +1
Partials 162 162 ☔ View full report in Codecov by Sentry. |
liam-lloyd
reviewed
Dec 11, 2024
Comment on lines
+45
to
+72
| build-storybook: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "18" | ||
|
|
||
| - uses: actions/cache@v4 | ||
| with: | ||
| path: node_modules | ||
| key: ${{ runner.os }}-node_modules-${{ hashFiles('**/package-lock.json') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-node_modules- | ||
|
|
||
| - name: Install dependencies | ||
| run: npm install | ||
|
|
||
| - name: Build Storybook | ||
| run: npm run build-storybook | ||
|
|
||
| - name: Archive `storybook-static` | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: storybook | ||
| path: storybook-static | ||
|
|
There was a problem hiding this comment.
I'd recommend factoring this (and the build job) into their own files and invoking them from each of the deploy actions via
jobs:
build:
uses: ./.github/workflows/build.yml
It looks to me like the artifact upload/download will just continue to work in that case, though I haven't tested this myself.
liam-lloyd
approved these changes
Dec 11, 2024
|
I'll merge this now and refactor it during the Potholes sprint since it seems a bit involved (and multiple open PRs have edits to the workflows right now and I'd prefer to merge these changes as soon as possible) |
To make Storybook easier to access for non-developers, we want to build a static version of it that gets deployed to each environment. This requires building a copy of Storybook alongside the main production build and then uploading that static Storybook directory as well. This is done by creating a new `build-storybook` step. Both Storybook and the main production build are uploaded in the `upload-code` step. Also update .gitignore to ignore the statically built Storybook directory. PER-9925: Build Storybook as part of web-app build process
meisekimiu
force-pushed
the
build-storybook
branch
from
747c730 to
7916e6c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To make Storybook easier to access for non-developers, we want to build a static version of it that gets deployed to each environment. This requires building a copy of Storybook alongside the main production build and then uploading that static Storybook directory as well. This is done by creating a new
build-storybookstep. Both Storybook and the main production build are uploaded in theupload-codestep.Also update .gitignore to ignore the statically built Storybook directory.
Steps to test:
/data/www/mdotcontains astorybookdirectory alongside its usualdistdirectory.storybookdirectory has built HTML/JavaScript files in it.This does not need any QA.