-
Notifications
You must be signed in to change notification settings - Fork 3
Fix storybook github pages publishing #1200
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
Conversation
7b87e11 to
7b381bb
Compare
| "html-webpack-plugin": "^5.6.0", | ||
| "mini-css-extract-plugin": "^2.6.1", | ||
| "ol-test-utilities": "0.0.0", | ||
| "react-refresh": "^0.14.2", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a peer-dependency of another package we use, @pmmmwh/react-refresh-webpack-plugin. Previously we were not installing the peer dep explicitly (it was added by react-scripts, I believe). Now that the github-pages workspace is removed, we needed to explicitly install it.
.github/workflows/publish_pages.yml
Outdated
| on: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: [$default-branch, cc/publish-pages] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove PR branch for cleanup
.github/workflows/publish_pages.yml
Outdated
| with: | ||
| path: ./frontends/mit-open/storybook-static | ||
|
|
||
| # Deploy job |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These comments aren't adding much. Perhaps not doing any harm; I'd remove them.
|
PR looks good. Now we have static hosting for the front end set up, let's pick up the conversation of publishing Storybook alongside it for branch PRs and environments. For the Storybook renaming, do you think it's worth making the distinction between components that form part of the design language - the Smoot Design components - and components that are just UI devices without any particular design - e.g. PlainList, Popover, the RoutedDrawer (arguably)? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small nit - the other workflow filenames are hyphened.
|
Might be worth updating the project README (last line) to say it's now publishing Storybook there. |
I do think that this is a good idea and worthwhile, but mostly I want to get this deployed and shareable with Steve/Simone. I suspect we will do some further reorganizing / renaming after they've looked at it a bit. I'd like to hold off on more reorganizing till then. |
What are the relevant tickets?
Description (What does it do?)
This PR:
github-pagesreact app.ol-components/storynameandsmoot-design/storyname. I've moved most things underol-components/tosmoot-design/(this only affects the storybook, not the workspace name) and renamedol-componentscategory to "old"How can this be tested?
yarn storybooklocally and compare with https://mitodl.github.io/mit-open/. They should be the same.