{"id":13533053,"url":"https://github.com/appleboy/gh-pages-action","last_synced_at":"2025-06-29T15:03:53.918Z","repository":{"id":65158921,"uuid":"245560549","full_name":"appleboy/gh-pages-action","owner":"appleboy","description":"A GitHub Action to deploy a static site on GitHub Pages.","archived":false,"fork":false,"pushed_at":"2021-02-13T03:08:35.000Z","size":236,"stargazers_count":27,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-06T15:31:17.794Z","etag":null,"topics":["actions","gh-pages","github-actions"],"latest_commit_sha":null,"homepage":"","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/appleboy.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}},"created_at":"2020-03-07T03:22:11.000Z","updated_at":"2023-11-07T12:53:51.000Z","dependencies_parsed_at":"2023-01-13T15:43:27.743Z","dependency_job_id":null,"html_url":"https://github.com/appleboy/gh-pages-action","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"d3d9541b0e8917bd93da785ec6fb1c63f265e185"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/appleboy/gh-pages-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgh-pages-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgh-pages-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgh-pages-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgh-pages-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appleboy","download_url":"https://codeload.github.com/appleboy/gh-pages-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgh-pages-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259973852,"owners_count":22940400,"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","gh-pages","github-actions"],"created_at":"2024-08-01T07:01:16.160Z","updated_at":"2025-06-29T15:03:53.883Z","avatar_url":"https://github.com/appleboy.png","language":"Shell","funding_links":[],"categories":["Community Resources"],"sub_categories":["GitHub Pages"],"readme":"# 🚀 GitHub Pages for GitHub Actions\n\n[GitHub Action](https://github.com/features/actions) for deploying a static site on GitHub Pages.\n\n![Deploy the static file to GitHub Page](https://github.com/appleboy/gh-pages-action/workflows/Deploy%20the%20static%20file%20to%20GitHub%20Page/badge.svg)\n\n## Usage\n\nDeploying a static site on GitHub Pages.\n\n```yaml\nname: Deploy the static file to GitHub Page\non: [push]\njobs:\n\n  build:\n    name: Build\n    runs-on: ubuntu-latest\n    steps:\n    - name: checkout\n      uses: actions/checkout@v1\n\n    - name: deploy docs\n      uses: ./\n      with:\n        username: ${{ secrets.USERNAME }}\n        password: ${{ secrets.PASSWORD }}\n        remote_url: https://github.com/appleboy/gh-pages-action.git\n```\n\nPlease create your own [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) on GitHub setting page and set the password as access token not your account password.\n\n![token](./images/Personal_Access_Tokens.png)\n\noutput:\n\n```sh\n D Dockerfile\n D LICENSE\n D README.md\n D action.yml\n D docs/index.html\n D entrypoint.sh\n?? index.html\n+ git add .\n+ git commit -m commit 6b0497a3b6f0f975c605c28950dbe15dedf4e8f0\nAuthor: Bo-Yi Wu \u003c***.tw@gmail.com\u003e\nDate:   Sat Mar 7 20:25:50 2020 +0800\n\n    chore: update\n\n[gh-pages f156e8c] commit 6b0497a3b6f0f975c605c28950dbe15dedf4e8f0 Author: Bo-Yi Wu \u003c***.tw@gmail.com\u003e Date:   Sat Mar 7 20:25:50 2020 +0800\n 7 files changed, 94 deletions(-)\n delete mode 100644 .github/workflows/ci.yml\n delete mode 100644 Dockerfile\n delete mode 100644 LICENSE\n delete mode 100644 README.md\n delete mode 100644 action.yml\n delete mode 100755 entrypoint.sh\n rename docs/index.html =\u003e index.html (100%)\n+ git push origin HEAD:gh-pages\nTo https://github.com/***/gh-pages-action.git\n   bd265c2..f156e8c  HEAD -\u003e gh-pages\n```\n\n## Input variables\n\nSee [action.yml](./action.yml) for more detailed information.\n\n* username - github username\n* password - github password or [create your personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)\n* upstream_name - git upstream to target, default is `origin`\n* target_branch - git branch to target, default is `gh-pages`\n* temporary_base - temporary directory for pages pull, default is `.tmp`\n* pages_directory - directory of content to publish, default is `docs`\n* target_directory - directory of content to sync\n* exclude - exclude files matching PATTERN\n* commit_author - git author name, default is `GitHub Action`\n* commit_author_email - git author email, default is `github-action@users.noreply.github.com`\n* remote_url - git remote url\n* workspace - git clone path\n\n### Example\n\nDeploy to target directory.\n\n```yaml\n- name: deploy to target directory\n  uses: ./\n  with:\n    username: ${{ secrets.USERNAME }}\n    password: ${{ secrets.PASSWORD }}\n    remote_url: https://github.com/appleboy/gh-pages-action.git\n    target_directory: 2020\n```\n\nCustom ignore list you don't want to sync.\n\n```yaml\n- name: exclude list\n  uses: ./\n  with:\n    username: ${{ secrets.USERNAME }}\n    password: ${{ secrets.PASSWORD }}\n    remote_url: https://github.com/appleboy/gh-pages-action.git\n    target_directory: ignore\n    exclude: ignore.html\n```\n\ncustom author email and name:\n\n```yaml\n- name: deploy to target directory\n  uses: ./\n  with:\n    username: ${{ secrets.USERNAME }}\n    password: ${{ secrets.PASSWORD }}\n    remote_url: https://github.com/appleboy/gh-pages-action.git\n    commit_author: foo\n    commit_author_email: bar@foobar.com\n    target_directory: 2020\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fgh-pages-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappleboy%2Fgh-pages-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fgh-pages-action/lists"}