{"id":13533072,"url":"https://github.com/crazy-max/ghaction-github-pages","last_synced_at":"2025-05-14T03:03:16.917Z","repository":{"id":39752997,"uuid":"205586305","full_name":"crazy-max/ghaction-github-pages","owner":"crazy-max","description":"GitHub Action to deploy to GitHub Pages","archived":false,"fork":false,"pushed_at":"2025-05-03T10:03:54.000Z","size":9849,"stargazers_count":472,"open_issues_count":2,"forks_count":53,"subscribers_count":5,"default_branch":"dev","last_synced_at":"2025-05-03T11:19:28.402Z","etag":null,"topics":["actions","deployment","github-actions","github-pages"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/github-pages","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crazy-max.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"crazy-max","custom":"https://www.paypal.me/crazyws"}},"created_at":"2019-08-31T19:13:14.000Z","updated_at":"2025-04-30T20:18:58.000Z","dependencies_parsed_at":"2023-11-09T11:28:48.011Z","dependency_job_id":"c387be7d-6ca4-4e92-8e63-04982268d52c","html_url":"https://github.com/crazy-max/ghaction-github-pages","commit_stats":{"total_commits":361,"total_committers":12,"mean_commits":"30.083333333333332","dds":0.3739612188365651,"last_synced_commit":"fbf0a4fa4e00f45accd6cf3232368436ec06ed59"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazy-max","download_url":"https://codeload.github.com/crazy-max/ghaction-github-pages/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253231342,"owners_count":21875083,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","deployment","github-actions","github-pages"],"created_at":"2024-08-01T07:01:16.353Z","updated_at":"2025-05-14T03:03:16.825Z","avatar_url":"https://github.com/crazy-max.png","language":"TypeScript","funding_links":["https://github.com/sponsors/crazy-max","https://www.paypal.me/crazyws"],"categories":["Community Resources","deployment","TypeScript"],"sub_categories":["GitHub Pages"],"readme":"[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-github-pages.svg?style=flat-square)](https://github.com/crazy-max/ghaction-github-pages/releases/latest)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-github--pages-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/github-pages)\n[![CI workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-github-pages/ci.yml?branch=dev\u0026label=ci\u0026logo=github\u0026style=flat-square)](https://github.com/crazy-max/ghaction-github-pages/actions?workflow=ci)\n[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github\u0026style=flat-square)](https://github.com/sponsors/crazy-max)\n[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square)](https://www.paypal.me/crazyws)\n\n## About\n\nA GitHub Action to deploy to GitHub Pages\n\n![GitHub Pages](.github/ghaction-github-pages.png)\n\n___\n\n* [Usage](#usage)\n  * [Workflow](#workflow)\n  * [Sign commits](#sign-commits)\n  * [Check availability of GitHub Pages](#check-availability-of-github-pages)\n* [Customizing](#customizing)\n  * [inputs](#inputs)\n  * [environment variables](#environment-variables)\n* [Contributing](#contributing)\n* [License](#license)\n\n## Usage\n\n### Workflow\n\nBelow is a simple snippet to deploy to GitHub Pages with a dummy HTML page.\n\nA [workflow](https://github.com/crazy-max/ghaction-github-pages/actions?query=workflow%3Aci)\nis also available for this repository and deploys [every day to GitHub Pages](https://crazy-max.github.io/ghaction-github-pages/).\n\n```yaml\nname: website\n\non: push\n\npermissions: \n  contents: write\n\njobs:\n  publish:\n    runs-on: ubuntu-latest\n    steps:\n      -\n        name: Checkout\n        uses: actions/checkout@v4\n      -\n        name: Gen dummy page\n        run: |\n          mkdir public\n          cat \u003e public/index.html \u003c\u003cEOL\n          \u003c!doctype html\u003e\n          \u003chtml\u003e\n            \u003chead\u003e\n              \u003ctitle\u003eGitHub Pages deployed!\u003c/title\u003e\n            \u003c/head\u003e\n            \u003cbody\u003e\n              \u003cp\u003eGitHub Pages with \u003cstrong\u003e${{ github.sha }}\u003c/strong\u003e commit ID has been deployed through \u003ca href=\"https://github.com/marketplace/actions/github-pages\"\u003eGitHub Pages action\u003c/a\u003e successfully.\u003c/p\u003e\n            \u003c/body\u003e\n          \u003c/html\u003e\n          EOL\n      -\n        name: Deploy to GitHub Pages\n        uses: crazy-max/ghaction-github-pages@v4\n        with:\n          target_branch: gh-pages\n          build_dir: public\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Sign commits\n\nYou can use the [Import GPG](https://github.com/crazy-max/ghaction-import-gpg)\naction along with this one to sign commits:\n\n```yaml\n      -\n        name: Import GPG key\n        uses: crazy-max/ghaction-import-gpg@v6\n        with:\n          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}\n          passphrase: ${{ secrets.PASSPHRASE }}\n          git_user_signingkey: true\n          git_commit_gpgsign: true\n      -\n        name: Deploy to GitHub Pages\n        uses: crazy-max/ghaction-github-pages@v4\n        with:\n          target_branch: gh-pages\n          build_dir: public\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Check availability of GitHub Pages\n\nYou can use the [GitHub Status](https://github.com/crazy-max/ghaction-github-status)\naction along with this one to check the availability of GitHub Pages before\ndeploying:\n\n```yaml\n      -\n        name: Check GitHub Pages status\n        uses: crazy-max/ghaction-github-status@v3\n        with:\n          pages_threshold: major_outage\n      -\n        name: Deploy to GitHub Pages\n        uses: crazy-max/ghaction-github-pages@v4\n        with:\n          target_branch: gh-pages\n          build_dir: public\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Customizing\n\n### inputs\n\nFollowing inputs can be used as `step.with` keys\n\n| Name                 | Type   | Description                                                                                                         |\n|----------------------|--------|---------------------------------------------------------------------------------------------------------------------|\n| `domain`             | String | Git domain (default `github.com`)                                                                                   |\n| `repo`               | String | GitHub repository where assets will be deployed (default `$GITHUB_REPOSITORY`)                                      |\n| `target_branch`      | String | Git branch where assets will be deployed (default `gh-pages`)                                                       |\n| `keep_history`       | Bool   | Create incremental commit instead of doing push force (default `false`)                                             |\n| `allow_empty_commit` | Bool   | Allow an empty commit to be created (default `true`)                                                                |\n| `build_dir`          | String | Build directory to deploy (**required**)                                                                            |\n| `absolute_build_dir` | Bool   | Whether to treat `build_dir` as an absolute path (defaults to `false`, making it relative to the working directory) |\n| `follow_symlinks`    | Bool   | If enabled, the content of symbolic links will be copied (default `false`)                                          |\n| `committer`          | String | Committer name and email address as `Display Name \u003cjoe@foo.bar\u003e` (defaults to the GitHub Actions bot user)          |\n| `author`             | String | Author name and email address as `Display Name \u003cjoe@foo.bar\u003e` (defaults to the GitHub Actions bot user)             |\n| `commit_message`     | String | Commit message (default `Deploy to GitHub pages`)                                                                   |\n| `fqdn`               | String | Write the given domain name to the CNAME file                                                                       |\n| `jekyll`             | Bool   | Allow Jekyll to build your site (default `true`)                                                                    |\n| `dry_run`            | Bool   | If enabled, nothing will be pushed (default `false`)                                                                |\n| `verbose`            | Bool   | Enable verbose output (default `false`)                                                                             |\n\n### environment variables\n\nFollowing environment variables can be used as `step.env` keys\n\n| Name           | Description                                                                                                                                                  |\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `GITHUB_TOKEN` | [GITHUB_TOKEN](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) as provided by `secrets`          |\n| `GH_PAT`       | Use a [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) if you want to deploy to another repo |\n\n## Contributing\n\nWant to contribute? Awesome! The most basic way to show your support is to star\nthe project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)\nor by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this\njourney continues indefinitely!\n\nThanks again for your support, it is much appreciated! :pray:\n\n## License\n\nMIT. See `LICENSE` for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fghaction-github-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazy-max%2Fghaction-github-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fghaction-github-pages/lists"}