{"id":18388333,"url":"https://github.com/cecilapp/github-pages-deploy","last_synced_at":"2026-04-06T03:05:37.811Z","repository":{"id":40336201,"uuid":"192131330","full_name":"Cecilapp/GitHub-Pages-deploy","owner":"Cecilapp","description":"A GitHub Action to deploy a static site on GitHub Pages.","archived":false,"fork":false,"pushed_at":"2023-08-14T22:32:08.000Z","size":353,"stargazers_count":42,"open_issues_count":0,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T17:43:47.791Z","etag":null,"topics":["action","gh-pages","github-actions"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/gh-pages-deploy","language":"Shell","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/Cecilapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":"ArnaudLigny","open_collective":"cecil"}},"created_at":"2019-06-15T23:10:28.000Z","updated_at":"2024-08-17T15:16:30.000Z","dependencies_parsed_at":"2023-01-11T17:21:52.417Z","dependency_job_id":"f6cccd86-0372-4f4f-b006-6004867b70fe","html_url":"https://github.com/Cecilapp/GitHub-Pages-deploy","commit_stats":{"total_commits":107,"total_committers":4,"mean_commits":26.75,"dds":"0.028037383177570097","last_synced_commit":"18b21493b3b92508912541cad41d189a050fd4cd"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cecilapp%2FGitHub-Pages-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cecilapp%2FGitHub-Pages-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cecilapp%2FGitHub-Pages-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cecilapp%2FGitHub-Pages-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cecilapp","download_url":"https://codeload.github.com/Cecilapp/GitHub-Pages-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247583107,"owners_count":20961970,"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":["action","gh-pages","github-actions"],"created_at":"2024-11-06T01:33:46.808Z","updated_at":"2026-04-06T03:05:37.806Z","avatar_url":"https://github.com/Cecilapp.png","language":"Shell","funding_links":["https://github.com/sponsors/ArnaudLigny","https://opencollective.com/cecil"],"categories":[],"sub_categories":[],"readme":"# GitHub Pages deploy\n\nThis Action deploys a static site on GitHub Pages.\n\n[![test](https://github.com/Cecilapp/GitHub-Pages-deploy/actions/workflows/test.yml/badge.svg)](https://github.com/Cecilapp/GitHub-Pages-deploy/actions/workflows/test.yml) [![pages-build-deployment](https://github.com/Cecilapp/GitHub-Pages-deploy/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/Cecilapp/GitHub-Pages-deploy/actions/workflows/pages/pages-build-deployment)\n\n## Usage\n\nSee [action.yml](action.yml).\n\n```yml\n- name: Deploy to GitHub Pages\n  uses: Cecilapp/GitHub-Pages-deploy@v3\n  env:\n    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n  with:\n    email: username@domain.tld      # required\n    build_dir: _site                # \"_site\" by default\n    branch: website                 # \"gh-pages\" by default\n    cname: domain.tld               # empty by default\n    jekyll: no                      # \"no\" by default\n    commit_message: custom message  # optional\n```\n\n### Workflow example\n\n```yml\nname: GitHub Pages deploy\non:\n  push:\n    branches:\n      - master\njobs:\n  build-and-deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n      - name: Build\n        uses: # build your static site\n\n      - name: Deploy to GitHub Pages\n        uses: Cecilapp/GitHub-Pages-deploy@v3\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          email: username@domain.tld\n          build_dir: _site\n```\n\n## About _user_ and _organization_ sites\n\n\u003e The default publishing source for user and organization sites is the root of the default branch for the repository.\n\nSee [documentation](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites).\n\n### v2 VS v3\n\n\u003e _GitHub Pages deploy_ v3 use the [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow) instead of a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (PAT), and [inputs parameters](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) instead of environment variables.\n\u003e If you want to continue using the previous release (with environment variables) you must set the version: [`Cecilapp/GitHub-Pages-deploy@v2`](https://github.com/marketplace/actions/gh-pages-deploy?version=2.0.1).\n\n## License\n\n_GitHub Pages deploy_ is a free software distributed under the terms of the MIT license.\n\n© [Arnaud Ligny](https://arnaudligny.fr)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcecilapp%2Fgithub-pages-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcecilapp%2Fgithub-pages-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcecilapp%2Fgithub-pages-deploy/lists"}