A GitHub Action to deploy static sites and assets to GitHub Pages with customizable options.
ghaction-github-pages is a GitHub Action designed to automate the deployment of static websites and assets to GitHub Pages. It takes content from a specified build directory and pushes it to a target branch, streamlining the process of publishing documentation, project sites, or static web applications. The action handles configurations like commit signing, Jekyll settings, and custom domains, reducing manual steps in CI/CD pipelines.
Developers and teams using GitHub Actions to automate static site deployments, particularly those maintaining documentation, project websites, or static web apps hosted on GitHub Pages.
It offers a reliable, feature-rich alternative to manual deployment or basic scripts, with extensive customization options and seamless integration into GitHub workflows. Its focus on GitHub Pages-specific needs and compatibility with other actions makes it a preferred choice for streamlined static site publishing.
GitHub Action to deploy to GitHub Pages
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Supports deployment to custom branches (default gh-pages) and cross-repository deployments using personal access tokens, enabling versatile publishing workflows.
Offers inputs for committer/author details, commit messages, Jekyll settings, and CNAME files, allowing precise control over deployment behavior.
Designed to work with companion actions like GPG signing and GitHub status checks, facilitating reliable and secure deployment pipelines.
Includes dry runs and verbose output options, helping developers troubleshoot deployments without risking live changes.
Exclusively built for GitHub Actions, making it unsuitable for projects on other CI/CD platforms or those requiring multi-cloud deployment strategies.
Inherits GitHub Pages' restriction to static sites, so it cannot handle server-side rendering or dynamic backend code without additional workarounds.
Cross-repo deployments require manual setup of personal access tokens (GH_PAT), adding security and configuration overhead compared to simpler actions.