{"repo":"peaceiris/actions-gh-pages","free":true,"listed":false,"github":"https://github.com/peaceiris/actions-gh-pages","clone":"git clone https://github.com/peaceiris/actions-gh-pages.git","description":"GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.","language":"TypeScript","stars":5356,"topics":["github-actions","github-pages","static-site-generator","actions","hugo","gatsby","mkdocs","vuepress","mdbook","nextjs"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"GitHub Pages Action [!NOTE] See also the GitHub official GitHub Pages Action first. - GitHub Pages now uses Actions by default The GitHub Blog - GitHub Pages: Custom GitHub Actions Workflows (beta) GitHub Changelog This is a GitHub Action to deploy your static files to GitHub Pages . This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, mdBook, Next, Nuxt, and so on.) [Static Site Generators]: https://jamstack.org/generators/ The next example step will deploy ./public directory to the remote gh-pages branch. For newbies of GitHub Actions: Note that the GITHUB TOKEN is NOT a personal access token. A GitHub Actions runner automatically creates a GITHUB TOKEN secret to authenticate in your workflow. So, you can start to deploy immediately without any configuration. Supported Tokens Three tokens are supported. Token Private repo Public repo Protocol Setup --- :---: :---: --- --- github token ✅️ ✅️ HTTPS Unnecessary deploy key ✅️ ✅️ SSH Necessary personal token ✅️ ✅️ HTTPS Necessary Notes: Actually, the GITHUB TOKEN works for deploying to GitHub Pages but it has still some limitations. For the first deployment, we need to select the gh-pages branch or another branch on the repository settings tab. See First Deployment with GITHUB TOKEN Supported Platforms All Actions runners: Linux (Ubuntu), macOS, and Windows are supported. runs-on github token deploy key personal token --- :---: :---: :---: ubuntu-22.04 ✅️ ✅️ ✅️ ubuntu-20.04 ✅","default_branch":null,"files":null,"tree":[],"storefront":"/r/peaceiris","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/peaceiris/actions-gh-pages/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}