sauloxd/Deploy static app in branch to gh-pages
Manages multiple static apps (or review-apps) for each branch in github pages
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| build-cmd | This is the build command to generate a production version of your application. For example, if you use "create-react-app", this would be "yarn build". IMPORTANT: If your app doesn't use HashRouting (the #/ in url), use process.env.PUBLIC_URL to correctly configure it. See FAQ and https://www.gatsbyjs.com/docs/path-prefix/ for more info. Also you can skip building your apps if you did it in a previous step. Remember that the "dist" path should be pointing to your app's build | — | — |
| branch | The branch you configured in github to be the source for gh-pages. Defaults to "gh-pages". See https://pages.github.com/ for more info. | — | gh-pages |
| dist | The directory where you build artifacts will live. For example, if you use create-react-app, it will be the "dist" directory. If you use a monorepo setup, please add the path relative from project's root or an absolute path' | — | dist |
| slug | The default URL for every app is: https://{ GH_USER_NAME }.github.io/{ REPOSITORY }/{ SLUG }/{ BRANCH_NAME }/{ HEAD_COMMIT } For multiple types of apps inside the same repository (i.e. APP & STORYBOOK), provide an uniq slug. Example: If you want something like: https://sauloxd.github.io/my-app/storybooks/ft-home-1231bdhb, pass string "storybooks" so it doesn't override other apps inside same respository. | — | review-apps |
| GITHUB_TOKEN | To allow action to comment the app urls in your pull request, please pass {{secrets.GITHUB_TOKEN}} to allow action to interact with your pull request. To see why it is needed, see: https://github.com/actions/toolkit/tree/main/packages/github | — | — |
| skip-index-html | Skip creating and overriden index.html in github pages branch. | — | false |
| apps | JSON config for all apps that will be managed by this action | — | — |
Outputs
no outputs