GitHub action to build and deploy React to GitHub Pages. This uses the new GitHub Actions method as the source. In the repository settings, go to Pages. Under Source, select GitHub Actions. No further configuration is needed.
The following inputs can be used as step.with
keys
Name | Type | Description |
---|---|---|
checkout |
T/F | Set to false if the code is already checked out (Default is true ) (Optional) |
path |
String | Path of output files, Default is dist (Optional) |
build_command |
String | Specifies the command to run after npm ci for the build, Default is npm run build (Optional) |
Create .github/workflow/deploy.yaml
with the following to build on push.
on:
push:
branches:
- "main"
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.build-publish.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- id: build-publish
uses: bitovi/github-actions-react-to-ghp@v1.2.0
with:
path: dist
We would love for you to contribute to bitovi/github-actions-react-to-ghp
. Issues and Pull Requests are welcome!
The scripts and documentation in this project are released under the MIT License.
Bitovi is a proud supporter of Open Source software.