# peaceiris/actions-gh-pages

GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.

Repository: https://github.com/peaceiris/actions-gh-pages
Canonical: https://ross.abutalabs.com/products/actions-gh-pages
Homepage: https://github.com/marketplace/actions/github-pages-action
Language: TypeScript
License: MIT
License Family: permissive
Topics: github-actions, github-pages, static-site-generator, actions, hugo, gatsby, mkdocs, vuepress, mdbook, nextjs, nuxt
Last push: 2026-08-26T18:09:24+00:00

## Health v2 (maintenance only)
Score: 82/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 51, longevity 100
- inputs: {"age_days": 2661, "days_push": 7, "days_rel": 113, "gap_med": null, "n_releases_24m": 1}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 5357, forks 451 (observed 2026-08-28T04:09:15.987744+00:00)

## What it is
A GitHub Action that deploys static files to GitHub Pages, publishing a directory to the gh-pages branch from CI workflows. It works with any static site generator such as Hugo, MkDocs, Gatsby, mdBook, Next.js, and Nuxt.

## Use cases
- deploy a static site to github pages from ci
- publish hugo site automatically on push
- deploy mkdocs documentation with github actions
- publish gatsby build output to gh-pages branch
- automate static site deployment without manual steps
- deploy next.js or nuxt static export to github pages

## When to choose
- you deploy static sites or docs to GitHub Pages from GitHub Actions
- you want zero-setup deployment using the built-in GITHUB_TOKEN
- you need SSH deploy key or personal token support for private repos
- you use any static site generator and just want to publish a build directory

## When to avoid
- you host on Netlify, Vercel, or another platform instead of GitHub Pages
- you need server-side rendering or dynamic hosting rather than static files
- GitHub's official Pages deploy action already covers your simple workflow

## Facets
- artifact type: plugin
- maturity: stable
- function: deployment, ci-cd, static-site-generator
- domain: web-development, documentation
- platform: windows, cloud
- tags: github-actions, github-pages, static-site-deployment, hugo, mkdocs, gatsby, jamstack, devops, automation, linux, macos

## Member repositories
- peaceiris/actions-gh-pages (main) score 82

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:15.987744+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:58:46.671458+00:00, confidence not recorded.
  - readme: https://github.com/peaceiris/actions-gh-pages (fetched 2026-08-28T04:09:15.987744+00:00, sha 5a492ebc4e2e)
  - homepage: https://github.com/marketplace/actions/github-pages-action (fetched 2026-08-29T08:53:21.446887+00:00, sha 8c74f41b32d4)
- Data as of 2026-08-30T08:39:29.467469+00:00.