github-pages-deploy-action
Automatically deploy projects to GitHub Pages using GitHub Actions
GraphCanon updated Sep 15, 2026 · GitHub synced Sep 15, 2026
30views this month
Decision brief
github-pages-deploy-action is an automation tool enabling deployment of production code to GitHub Pages via specified workflows in your repository.
Good fit when
- If you need precise control over the branch where your project will be deployed, since this action allows you to specify any branch for deployment.
- For projects that require a pre-built folder as input and benefit from automation using TypeScript scripts for CI/CD processes.
Avoid when
- When looking for a more complex deployment configuration than GitHub Pages offers, such as multi-service orchestration or advanced environment management.
- If your project does not fit well with the default branch naming conventions (like gh-pages), and you do not wish to configure alternative branches manually.
- Requirements:
- Your repository must be configured with 'Read and Write Permissions' for the GITHUB_TOKEN or have an access token/SSH key provided in the workflow file.; The action requires you to include the `actions/checkout` step before running the deploy action, as well as configure your Pages branch settings properly.
Observed Jul 16, 2026 · Source: enrich:decision_facts
Verify the decision
Adoption
Package downloads where a registry match exists. GitHub stars (4,606) are secondary evidence.
- npm downloads (30d)
- 673·npm downloads API·Sep 15, 2026
Maintenance and security
Full trust report- Maintenance
- Very active (0d since push)
- As of Sep 15, 2026
- Provenance
- Not a fork · Personal account
- As of Sep 15, 2026
- Security (OSV)
- No lockfile
- As of Jul 15, 2026
Public GitHub metadata and optional OSV scans. Signals, not a guarantee. Trust methodology.
Install
npm install github-pages-deploy-actionSimilar tools
Same-category neighbours. No typed graph edges are catalogued for this tool yet.
Evidence and technical details
Sourced facts, taxonomy, compatibility claims, README excerpt, and machine-readable endpoints.
Overview
This repository offers a GitHub Action that enables automatic deployment of production-ready code to any specified branch via GitHub Pages.
Capability facts
- MCP server
- No MCP server detected
Source: repo_scan · Sep 15, 2026
- Languages
- typescript, javascript
Source: github.language+package.json · Sep 15, 2026
Categories
Tags
README
Getting Started :airplane: You can include the action in your workflow to trigger on 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 step b...
For agents
This page has a .md twin and JSON over the API.