# tschaub/gh-pages

General purpose task for publishing files to a gh-pages branch on GitHub

Repository: https://github.com/tschaub/gh-pages
Canonical: https://ross.abutalabs.com/products/gh-pages
Homepage: https://www.npmjs.com/package/gh-pages
Language: JavaScript
License: MIT
License Family: permissive
Last push: 2026-03-26T07:53:28+00:00

## Health v2 (maintenance only)
Score: 63/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 74, release rhythm 28, longevity 100
- inputs: {"age_days": 4551, "days_push": 160, "days_rel": 608, "gap_med": 83, "n_releases_24m": 2}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3345, forks 203 (observed 2026-08-28T04:07:57.602195+00:00)

## What it is
A Node.js library that publishes files to a gh-pages branch on GitHub (or any branch on any remote) by cloning, committing, and pushing automatically. It is commonly used to deploy static sites from build output directories.

## Use cases
- deploy a static site to github pages from a dist folder
- publish build output to a gh-pages branch
- automate github pages deployment in npm scripts
- push files to any git branch on any remote
- host documentation site on github pages

## When to choose
- you deploy static sites or docs to GitHub Pages from Node.js projects
- you want a simple programmatic or CLI-based publish step without CI-specific plugins
- you need to push to an arbitrary branch or remote, not just gh-pages

## When to avoid
- you deploy server-rendered apps rather than static files
- you use a non-Node toolchain with dedicated deployment tooling
- you need GitHub Actions-native Pages deployment workflows

## Facets
- artifact type: library
- maturity: stable
- function: deployment, developer-tools, cli
- domain: web-development, developer-tools, version-control
- platform: cli, cross-platform
- tags: github-pages, git, static-site-deployment, npm-package, nodejs

## Member repositories
- tschaub/gh-pages (main) score 63

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:57.602195+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-29T18:41:01.580991+00:00, confidence not recorded.
  - readme: https://github.com/tschaub/gh-pages (fetched 2026-08-28T04:07:57.602195+00:00, sha 2eb050fd45f1)
  - registry_npm: https://registry.npmjs.org/gh-pages (fetched 2026-08-29T09:34:21.413708+00:00, sha 66b35a395258)
- Data as of 2026-08-30T08:39:29.467469+00:00.