Luigit
repositories / dotfiles

dotfiles

bugabingas dorkfiles

owned by admin

pi/agent/skillz/github/github-cli/references/pages-deploy.md

Raw
Rendered preview

Pages deployment helper

Inspects and changes GitHub Pages through gh api, or scaffolds a deployment workflow.

node scripts/gh_pages_deploy.mjs status owner/repo --json
node scripts/gh_pages_deploy.mjs status owner/repo --build-info
node scripts/gh_pages_deploy.mjs enable owner/repo --dry-run --json
node scripts/gh_pages_deploy.mjs rebuild owner/repo --json
node scripts/gh_pages_deploy.mjs create-workflow --site-dir dist --dry-run
node scripts/gh_pages_deploy.mjs create-workflow --site-dir dist --output .github/workflows/pages.yml

create-workflow requires a safe repository-relative directory containing only publishable artifacts. It refuses existing files unless --force is supplied; --dry-run never writes, including with --force. Review generated workflows before committing them.

Check current API behavior with gh api --help and the GitHub Pages REST documentation.

# Pages deployment helper

Inspects and changes GitHub Pages through `gh api`, or scaffolds a deployment workflow.

```text
node scripts/gh_pages_deploy.mjs status owner/repo --json
node scripts/gh_pages_deploy.mjs status owner/repo --build-info
node scripts/gh_pages_deploy.mjs enable owner/repo --dry-run --json
node scripts/gh_pages_deploy.mjs rebuild owner/repo --json
node scripts/gh_pages_deploy.mjs create-workflow --site-dir dist --dry-run
node scripts/gh_pages_deploy.mjs create-workflow --site-dir dist --output .github/workflows/pages.yml
```

`create-workflow` requires a safe repository-relative directory containing only publishable artifacts.
It refuses existing files unless `--force` is supplied; `--dry-run` never writes, including with `--force`.
Review generated workflows before committing them.

Check current API behavior with `gh api --help` and the GitHub Pages REST documentation.