{"id":17967732,"url":"https://github.com/testthedocs/github-pages-deploy-action","last_synced_at":"2025-03-25T08:31:28.424Z","repository":{"id":65162010,"uuid":"231402752","full_name":"testthedocs/github-pages-deploy-action","owner":"testthedocs","description":null,"archived":false,"fork":true,"pushed_at":"2021-02-23T10:40:20.000Z","size":2101,"stargazers_count":14,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T14:51:13.537Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"grasilife/github-pages-deploy-action","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/testthedocs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-02T14:54:16.000Z","updated_at":"2023-10-12T12:41:44.000Z","dependencies_parsed_at":"2023-01-04T12:39:03.958Z","dependency_job_id":null,"html_url":"https://github.com/testthedocs/github-pages-deploy-action","commit_stats":{"total_commits":133,"total_committers":7,"mean_commits":19.0,"dds":"0.27819548872180455","last_synced_commit":"ef988eb517cf14bf44186cd648ecf1f786c666b8"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testthedocs%2Fgithub-pages-deploy-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testthedocs%2Fgithub-pages-deploy-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testthedocs%2Fgithub-pages-deploy-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testthedocs%2Fgithub-pages-deploy-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/testthedocs","download_url":"https://codeload.github.com/testthedocs/github-pages-deploy-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245426290,"owners_count":20613324,"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":[],"created_at":"2024-10-29T14:09:19.681Z","updated_at":"2025-03-25T08:31:27.824Z","avatar_url":"https://github.com/testthedocs.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# GitHub Pages Deploy Action :rocket:\n\nThis [GitHub action](https://github.com/features/actions) will handle the building and deploy process of your project to [GitHub Pages](https://pages.github.com/).\n\nIt only supports uploading to the `gh-pages` branch!\n\nThis action is built on [Node](https://nodejs.org/en/), which means that you can call any optional build scripts your project requires prior to deploying.\n\n## Getting Started :airplane:\n\nYou can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows).\n\nIf the remote branch that you wish to deploy to doesn't already exist the action will create it for you.\n\nYour workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work.\n\nYou can view an example of this below.\n\n```yml\nname: Build and Deploy\non: [push]\njobs:\n  build-and-deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - name: Checkout\n      uses: actions/checkout@master\n\n    - name: Build and Deploy\n      uses: testthedocs/github-pages-deploy-action@master\n      env:\n        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}\n        BUILD_DIR: test/build/ # The folder, the action should deploy.\n        BUILD_SCRIPT: npm install \u0026\u0026 npm run-script build # The build script the action should run prior to deploying.\n```\n\nIf you'd like to make it so the workflow only triggers on push events to specific branches then you can modify the `on` section.\n\n```yml\non:\n  push:\n    branches:\n      - master\n```\n\n## Configuration\n\nThe `env` portion of the workflow **must** be configured before the action will work.\nYou can add these in the `env` section found in the examples above.\n\nAny `secrets` must be referenced using the bracket syntax and stored in the GitHub repositories `Settings/Secrets` menu.\n\nYou can learn more about setting environment variables with GitHub actions [here](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsenv).\n\nBelow you'll find a description of what each option does.\n\n\n`ACCESS_TOKEN`: Depending on the repository permissions you may need to provide the action with a GitHub personal access token instead of the provided GitHub token in order to deploy.\nYou can [learn more about how to generate one here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).\n\n**This should be stored as a secret**.\n\n`BUILD_SCRIPT`: If you require a build script to compile your code prior to pushing it you can add the script here.\n\nThe Docker container which powers the action runs Node which means `npm` commands are valid.\n\n`BUILD_DIR`: The folder, the action should deploy.\n\nWith the action correctly configured you should see the workflow trigger the deployment under the configured conditions.\n\n## Contributing\n\nWe are a community effort, and everybody is most welcome to participate!\n\nBe it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.\n\n## Credits\n\n- [ghpages](https://github.com/maxheld83/ghpages)\n- [github-pages-deploy-action](https://github.com/grasilife/github-pages-deploy-action)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestthedocs%2Fgithub-pages-deploy-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftestthedocs%2Fgithub-pages-deploy-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestthedocs%2Fgithub-pages-deploy-action/lists"}