peaceiris/actions-gh-pages
Actions Gh Pages
This project is a GitHub Action designed to automate the deployment of static files and generated sites to GitHub Pages. It functions as a deployment tool that pushes build artifacts from a workflow to a remote Git repository branch for web hosting.
The tool supports publishing to external repositories, enabling a private-to-public workflow to keep source code hidden. It also provides compatibility with GitHub Enterprise Server instances for deployments within private corporate environments.
Core capabilities include managing the hosting branch through the creation of orphan branches to remove commit history, specifying custom publishing branches, and tagging deployment versions. The project handles site configuration via CNAME record injection and Jekyll processing toggles, while offering asset management through glob-pattern filtering and the preservation of existing destination files.
Authentication is managed using runner tokens, SSH deploy keys, or personal access tokens.
Features
- GitHub Pages Deployments - Automates the publishing of static websites to GitHub Pages from a GitHub Actions workflow.
- Static Hosting Deployments - Publishes a directory of static files to a hosting branch using custom destination directories and absolute paths.
- Artifact Branching - Updates a dedicated hosting branch by pushing local static assets and managing commit histories via Git.
- Static Site Deployments - Provides an automated workflow component for publishing output from static site generators to a remote Git branch.
- Static Site Hosting - Provides automated deployment strategies for serving pre-rendered static content on GitHub Pages.
- Deployment Branch Managers - Manages hosting branches through the creation of orphan branches and custom publishing targets.
- Orphan Branch Creation - Creates a fresh branch with a single commit to eliminate historical metadata and reduce repository size.
- Cross-Repository Deployments - Supports pushing assets to a different repository than the one running the action for private-to-public workflows.
- Deployment Asset Exclusions - Implements glob-pattern matching to exclude specific files or directories from the deployment payload.
- Build Artifact Deployment - Stages build artifacts in a temporary runner environment before synchronizing them with the target publishing branch.
- Enterprise Server Integrations - Connects to enterprise server instances to deploy static sites within private corporate environments.
- Private-to-Public Deployments - Enables pushing build assets from a private repository to a separate public repository to keep source code hidden.
- Static Site Deployment - Publishes static content to GitHub Enterprise Server instances within a private corporate network environment.
- Remote Branch Publishing - Enables specifying a custom branch name to use for hosting the site instead of the default branch.
- Deployment Asset Filtering - Allows excluding specific files or directories from the deployment using glob patterns to keep the production site clean.
- Remote Repository Authentication - Secures repository access using GitHub personal access tokens or SSH keys for authenticated pushes.
- Custom Domain Configurations - Manages CNAME records and domain configuration files during the automated deployment of a static site.
- Static Site Deployment - General purpose deployment to GitHub Pages.
