{"meta":{"name":"FindSoftware","page":"https://findsoftware.frbit.cloud/github-pages-deploy-action/","markdown":"https://findsoftware.frbit.cloud/github-pages-deploy-action.md","license":"https://creativecommons.org/licenses/by/4.0/","attribution":"FindSoftware, CC BY 4.0","note":"Attributes are recorded, never scored. An absent field means unknown, never zero and never bad."},"record":{"id":"github-pages-deploy-action","name":"GitHub Pages Deploy Action","urls":{"repository":"https://github.com/JamesIves/github-pages-deploy-action","docs":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md"},"category":["dev-tool"],"description":"GitHub Action that pushes a project's built folder to a branch that GitHub Pages serves.","maintainer":"James Ives","maintainerType":"individual","firstRelease":2019,"hosting":null,"language":"javascript","runtimeMin":null,"contentStore":null,"databases":null,"adminUi":null,"headlessApi":null,"templating":null,"i18n":null,"runsAs":["local"],"renderingModes":null,"installMethod":"GitHub Actions workflow step","licenseModel":"open-source","license":"MIT","currentMajor":"4","latestReleaseDate":"2026-08-08T00:00:00.000Z","githubStargazers":4618,"contributors":39,"packagistDownloads":null,"checkedAt":"2026-10-28T00:00:00.000Z","addedAt":"2026-10-28T00:00:00.000Z","sources":[{"field":"urls","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"urls","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"license","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"licenseModel","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/LICENSE","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"maintainer","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/LICENSE","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"language","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"category","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"runsAs","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"installMethod","url":"https://github.com/JamesIves/github-pages-deploy-action/blob/dev/README.md","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"firstRelease","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"currentMajor","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"latestReleaseDate","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action/releases","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"githubStargazers","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action","checkedAt":"2026-10-28T00:00:00.000Z"},{"field":"contributors","url":"https://api.github.com/repos/JamesIves/github-pages-deploy-action/contributors","checkedAt":"2026-10-28T00:00:00.000Z"}],"status":"active","ai":"authored"},"prose":"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.\n\n## Worth knowing\n\nWithout 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."}