README.md

GitHub Action: Deploy - GitHub Pages

---

Overview

Action to deploy a static site to GitHub Pages.

Permissions

Set permissions to deploy to pages.

permissions:
  pages: write
  id-token: write

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  with:
    # The path to the assets to deploy.
    # Can be absolute or relative $GITHUB_WORKSPACE.
    build-path: ""

    # The ID of the "build" artifact to download.
    # If not set, the action will use the local workspace files.
    build-artifact-id: ""

    # The path to the performance budget file. See action [Check - URL - Lighthouse](../../check/url-lighthouse/README.md).
    # Default: `./budget.json`
    budget-path: ./budget.json

    # The static site generator used to build the site. See https://github.com/actions/configure-pages.
    static-site-generator: ""

    # Whether to run URL checks after deployment.
    #
    # Default: `true`
    checks: "true"

    # GitHub Token for deploying to GitHub Pages.
    # Permissions:
    # - pages: write
    # - id-token: write
    # See https://github.com/actions/deploy-pages.
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

Inputs

Input	Description	Required	Default
build-path	The path to the assets to deploy.	false	-
	Can be absolute or relative $GITHUB_WORKSPACE.
build-artifact-id	The ID of the "build" artifact to download.	false	-
	If not set, the action will use the local workspace files.
budget-path	The path to the performance budget file. See action Check - URL - Lighthouse.	false	./budget.json
static-site-generator	The static site generator used to build the site. See https://github.com/actions/configure-pages.	false	-
checks	Whether to run URL checks after deployment.	false	true
github-token	GitHub Token for deploying to GitHub Pages.	false	${{ github.token }}
	Permissions:
	- pages: write
	- id-token: write
	See https://github.com/actions/deploy-pages.

Outputs

Output	Description
url	The URL of the deployed site.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.