https://github.com/codeship/storybook-surge-github-action
Build and deploy your storybook.js to branch specific Surge.sh sites
https://github.com/codeship/storybook-surge-github-action
Last synced: 9 months ago
JSON representation
Build and deploy your storybook.js to branch specific Surge.sh sites
- Host: GitHub
- URL: https://github.com/codeship/storybook-surge-github-action
- Owner: codeship
- Created: 2018-10-19T17:48:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-21T18:55:33.000Z (over 7 years ago)
- Last Synced: 2025-03-31T12:58:10.399Z (11 months ago)
- Language: Shell
- Size: 4.88 KB
- Stars: 13
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Deploy your storybook.js to branch specific surge.sh domains
This action will take an existing storybook configuration and deploy that storybook to branch specific static surge.sh sites.
Intended to be set up on `push`
### Required Secrets
You can set these up within the workflow editor tool.
- `SURGE_LOGIN`
- `SURGE_TOKEN`
### Behavior
When you push to your repository this action will:
- Start a pending GitHub Deployment for the branch
- Build your storybook
- Deploy your storybook to a public surge.sh site
- Update the pending GitHub Deployment with the URL of the storybook.
The urls follow the pattern:
https://{repo_owner}-{repo_name}-storybook-{branch_name}.surge.sh
### Example workflow
```
workflow "Storybook" {
on = "push"
resolves = ["Publish Storybook to Surge.sh"]
}
action "Publish Storybook to Surge.sh" {
uses = "codeship/storybook-surge-github-action@0.0.1"
secrets = [
"SURGE_LOGIN",
"SURGE_TOKEN",
"GITHUB_TOKEN",
]
}
```