Skip to content
This repository has been archived by the owner on Jan 16, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add documentation on using storybook-deployer to deploy on GitHub Pages
  • Loading branch information
erlendmiljo committed Jun 22, 2022
1 parent 5348ddb commit 261b77e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,18 @@ Or if your access token is stored in the `GITHUB_TOKEN` environment variable
npm run deploy-storybook -- --ci --host-token-env-variable=GITHUB_TOKEN
```

### Deploying Storybook to GitHub Pages as part of a GitHub Action

If you are deploying Storybook to GitHub Pages from a repository belonging to an organization account on GitHub, you may need to specify a ```${{ github.actor }}``` in addition to the ```${{ secrets.GITHUB_TOKEN }}``` for your build step to be able to authenticate properly.

For instance:
```
- name: Deploy storybook to GitHub Pages
run: npm run deploy-storybook -- --ci
env:
GH_TOKEN: ${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}
```

### Custom deploy configuration

If you want to customize Git username, email or commit message, add this to `package.json`:
Expand Down

0 comments on commit 261b77e

Please sign in to comment.