# GitHub Pages Deploy Action

GitHub Action that pushes a project's built folder to a branch that GitHub Pages serves.


Source: https://findsoftware.frbit.cloud/github-pages-deploy-action/
Last reviewed: 2026-10-28
Listed since: 2026-10-28

## Record

### Links

- repository: https://github.com/JamesIves/github-pages-deploy-action
- docs: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md

### Identity

- status: active
- maintainer: James Ives
- maintainerType: individual
- parent: unknown
- firstRelease: 2019
- hqCountry: unknown

### Kind

- category: dev-tool
- hosting: not applicable
- language: javascript
- runtime: unknown
- runtimeMin: not applicable
- basedOn: unknown

### Content

- contentStore: not applicable
- databases: not applicable
- adminUi: not applicable
- headlessApi: not applicable
- templating: not applicable
- i18n: not applicable

### Rendering and deploy

- runsAs: local
- renderingModes: not applicable
- installMethod: GitHub Actions workflow step

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 4
- latestReleaseDate: 2026-08-08

### Adoption

- githubStargazers: 4618
- packagistDownloads: not applicable
- npmWeeklyDownloads: unknown
- contributors: 39
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- urls: https://api.github.com/repos/JamesIves/github-pages-deploy-action (read 2026-10-28)
- urls: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md (read 2026-10-28)
- license: https://api.github.com/repos/JamesIves/github-pages-deploy-action (read 2026-10-28)
- licenseModel: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/LICENSE (read 2026-10-28)
- maintainer: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/LICENSE (read 2026-10-28)
- language: https://api.github.com/repos/JamesIves/github-pages-deploy-action (read 2026-10-28)
- category: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md (read 2026-10-28)
- runsAs: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md (read 2026-10-28)
- installMethod: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md (read 2026-10-28)
- firstRelease: https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases (read 2026-10-28)
- currentMajor: https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases (read 2026-10-28)
- latestReleaseDate: https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases (read 2026-10-28)
- githubStargazers: https://api.github.com/repos/JamesIves/github-pages-deploy-action (read 2026-10-28)
- contributors: https://api.github.com/repos/JamesIves/github-pages-deploy-action/contributors (read 2026-10-28)

## Notes

GitHub Pages Deploy Action is a GitHub Action that a workflow runs after its build step. It pushes the folder named in its `folder` input to a branch, `gh-pages` by default, which GitHub Pages serves as the site. The action deploys with the repository's own token by default, and a personal access token or an SSH deploy key can be set in its inputs instead. Unless `single-commit` is set, the deployment branch keeps its history, and with `clean` on, the default, files that left the source are removed from it.

## Worth knowing

Without a token or SSH key, the workflow needs read and write permission on the repository token, or `contents: write` in the workflow file. With `single-commit` enabled, existing history on the deployment branch is wiped. The README says the action is developed on Ubuntu, and for a Windows build it suggests moving the built folder to an Ubuntu job through artifacts.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0