Skip to content
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

Add workflow for deploy storybook #160

Merged
merged 3 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/storybook-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Deploy Storybook

on:
push:
branches:
- "*"
pull_request:
branches:
- "*"

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [16, 18, 20]

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- name: Install dependencies
run: yarn install

- name: Build Storybook
run: |
cd apps/design-system
yarn build-storybook

- name: Deploy Storybook
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./storybook-static
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

The Sistent Design System from Layer5 provides the open source building blocks to design and implement consistent, accessible, and delightful product experiences.


### Packages

Design System components in React, usually built with Vite.
Expand All @@ -25,7 +24,7 @@ List of npm packages:

Before you begin, ensure you have the following installed on your system:

- Node.js
- Node.js
- Yarn

### How to get started
Expand All @@ -37,7 +36,6 @@ Use `corepack enable` to go ahead and install yarn.

<div>&nbsp;</div>


### Installation

To set up the project, run the following command to install dependencies:
Expand All @@ -46,25 +44,28 @@ To set up the project, run the following command to install dependencies:
setup:
yarn install
```

To build the project, you can use the following command:

```
build: install
yarn run build-all
```

To check if your code meets the formatting standards, you can run:

```
format-check:
yarn run format:check
```

To automatically fix formatting issues, you can run

```
format-fix:
yarn run format:write
```


## Join the Layer5 community!

<a name="contributing"></a><a name="community"></a>
Expand Down