jamesives/Deploy to GitHub Pages

This action will handle the deployment process of your project to GitHub Pages.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jul 5, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: jamesives/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
ssh-key	This option allows you to define a private SSH key to be used in conjunction with a repository deployment key to deploy using SSH. The private key should be stored in the `secrets / with` menu as a secret. The public should be stored in the repositories deployment keys menu and be given write access. Alternatively you can set this field to `true` to enable SSH endpoints for deployment without configuring the ssh client. This can be useful if you've already setup the SSH client using another package or action in a previous step.	no	—
token	This option defaults to the repository scoped GitHub Token. However if you need more permissions for things such as deploying to another repository, you can add a Personal Access Token (PAT) here. This should be stored in the `secrets / with` menu as a secret. We recommend using a service account with the least permissions necessary and when generating a new PAT that you select the least permission scopes required. [Learn more about creating and using encrypted secrets here.](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)	no	${{ github.token }}
branch	This is the branch you wish to deploy to, for example gh-pages or docs.	no	gh-pages
folder	The folder in your repository that you want to deploy. If your build script compiles into a directory named build you would put it here. Folder paths cannot have a leading / or ./. If you wish to deploy the root directory you can place a . here.	yes	—
target-folder	If you would like to push the contents of the deployment folder into a specific directory on the deployment branch you can specify it here.	no	—
commit-message	If you need to customize the commit message for an integration you can do so.	no	—
clean	If your project generates hashed files on build you can use this option to automatically delete them from the target folder on the deployment branch with each deploy. This option is on by default and can be toggled off by setting it to false.	no	true
clean-exclude	If you need to use clean but you would like to preserve certain files or folders you can use this option. This should contain each pattern as a single line in a multiline string.	no	—
dry-run	Do not actually push back, but use `--dry-run` on `git push` invocations instead.	no	—
force	Whether to force-push and overwrite any existing deployment. Setting this to false will attempt to rebase simultaneous deployments. This option is on by default and can be toggled off by setting it to false.	no	true
git-config-name	Allows you to customize the name that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the name in the GitHub context, followed by the name of the action.	no	—
git-config-email	Allows you to customize the email that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the email in the GitHub context, followed by a generic noreply GitHub email.	no	—
repository-name	Allows you to specify a different repository path so long as you have permissions to push to it. This should be formatted like so: JamesIves/github-pages-deploy-action	no	—
tag	Add a tag to the commit, this can be used like so: 'v0.1'. Only works when 'dry-run' is not used.	no	—
single-commit	This option can be used if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history.	no	—
silent	Silences the action output preventing it from displaying git messages.	no	—
attempt-limit	How many rebase attempts to make before suspending the job. This option defaults to `3` and may be useful to increase when there are multiple deployments in a single branch.	no	3

Outputs

name	description
deployment-status	The status of the deployment that indicates if the run failed or passed. Possible outputs include: success\|failed\|skipped