스토리북 및 크로마틱 자동 배포 워크플로우 추가 셋업 #11
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * @froggy1014 |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # .github/workflows/chromatic.yml | ||
| name: "Chromatic Deployment" | ||
| run-name: Storybook deployment by ${{ github.actor }} | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - develop | ||
| paths: | ||
| - "**.stories.tsx" | ||
|
|
||
| jobs: | ||
| chromatic: | ||
| name: Run Chromatic Deployment | ||
| # Operating System | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| status: ${{ job.status }} | ||
|
|
||
| # Job steps | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - uses: pnpm/action-setup@v4 | ||
| name: Install pnpm | ||
| with: | ||
| version: 9 | ||
| run_install: false | ||
|
|
||
| - name: Set up Node.js version | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 20.x | ||
| cache: "pnpm" | ||
| cache-dependency-path: "**/pnpm-lock.yaml" | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install | ||
|
|
||
| - name: Run Chromatic | ||
| id: chromatic | ||
| uses: chromaui/action@latest | ||
| with: | ||
| projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }} | ||
| buildScriptName: build-storybook | ||
| onlyChanged: true | ||
|
|
||
| - name: comment PR | ||
| uses: thollander/actions-comment-pull-request@v1 | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| message: "💅 ## storybook-URL - ${{ steps.chromatic.outputs.storybookUrl }}" |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import type { StorybookConfig } from "@storybook/nextjs"; | ||
|
|
||
| const config: StorybookConfig = { | ||
| stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"], | ||
| addons: [ | ||
| "@storybook/addon-onboarding", | ||
| "@storybook/addon-links", | ||
| "@storybook/addon-essentials", | ||
| "@chromatic-com/storybook", | ||
| "@storybook/addon-interactions", | ||
| ], | ||
| framework: { | ||
| name: "@storybook/nextjs", | ||
| options: {}, | ||
| }, | ||
| staticDirs: ["../public"], | ||
|
|
||
| typescript: { | ||
| reactDocgen: "react-docgen-typescript", | ||
| }, | ||
| }; | ||
| export default config; | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import type { Preview } from "@storybook/react"; | ||
| import "../src/styles/globals.css"; | ||
|
|
||
| const preview: Preview = { | ||
| parameters: { | ||
| controls: { | ||
| matchers: { | ||
| color: /(background|color)$/i, | ||
| date: /Date$/i, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
Comment on lines
+4
to
+13
There was a problem hiding this comment. 제가 emotion으로만 스토리북을 구상 해봤어서 그런데 There was a problem hiding this comment. Wrapper Component가 추가된다면 어떤 경우인지 혹시 알려주실 수 있나요? There was a problem hiding this comment. Root.tsx 생각하시면 이해하기 편해요~ const ThemeWrapper = ({ children }) => (
<ThemeProvider theme={theme}>
<Global styles={global} />
{children}
</ThemeProvider>
)
export const decorators = [(renderStory) => <ThemeWrapper>{renderStory()}</ThemeWrapper>]스토리북에서도 Root 단에 필요한 로직이나 스타일링이 있다면 preview를 JSX 문법으로 활용할 수 있다는 의미였어요! |
||
|
|
||
| export default preview; | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
필수 애드온은 잘 정의되어 있네요!
이외 config 코드도 이견 없습니다~