Download
Automatically deploy your project to GitHub Pages using GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like. You can include the action in your workflow to trigger any event that GitHub actions supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the actions/checkout step before this workflow runs in order for the deployment to work. If you intend to make multiple deployments in quick succession you may need to leverage the concurrency parameter in your workflow to prevent overlaps. The with portion of the workflow must be configured before the action will work. You can add these in the with section found in the examples above. Any secrets must be referenced using the bracket syntax and stored in the GitHub repository's Settings/Secrets menu.
Features
- Install as a Node Module
- It's recommended that you use Dependabot to keep your workflow up-to-date and secure
- Customize the name that is attached to the git config
- Specify a different repository path so long as you have permissions to push to it
- With the action correctly configured you should see the workflow trigger the deployment under the configured conditions
- Use a SSH Deploy Key
Project Samples
