{"id":17712706,"url":"https://github.com/awibox/deploy-to-github-pages-action","last_synced_at":"2025-04-21T03:32:25.149Z","repository":{"id":63434826,"uuid":"234867128","full_name":"awibox/deploy-to-github-pages-action","owner":"awibox","description":":rocket: GitHub action that will help deploy your app to the repository for GitHub Pages","archived":false,"fork":false,"pushed_at":"2023-09-13T07:34:24.000Z","size":28,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T13:58:36.829Z","etag":null,"topics":["deployment","frontend","github-action","github-pages"],"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/awibox.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-19T08:40:51.000Z","updated_at":"2023-09-01T21:28:46.000Z","dependencies_parsed_at":"2024-10-25T11:37:04.603Z","dependency_job_id":"9ca0e02d-a9b4-4d59-9110-c7c837e85d49","html_url":"https://github.com/awibox/deploy-to-github-pages-action","commit_stats":{"total_commits":17,"total_committers":1,"mean_commits":17.0,"dds":0.0,"last_synced_commit":"ead4c5cc414e0ca1d357cc777a1b8e546b7137a6"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awibox%2Fdeploy-to-github-pages-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awibox%2Fdeploy-to-github-pages-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awibox%2Fdeploy-to-github-pages-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awibox%2Fdeploy-to-github-pages-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/awibox","download_url":"https://codeload.github.com/awibox/deploy-to-github-pages-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249991138,"owners_count":21357205,"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":["deployment","frontend","github-action","github-pages"],"created_at":"2024-10-25T09:42:37.949Z","updated_at":"2025-04-21T03:32:24.928Z","avatar_url":"https://github.com/awibox.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deploy to GitHub pages\n\nYou can use GitHub Pages like hosting for your project.\nTo do this, you need to create a repository and activate GitHub Pages for the master branch and bind your domain.\nThen use this action to help you set up automatic deployment from your app to your repository for GitHub Pages.\n\n## Getting started\n\nCreate a `deploy.yml` file in the workflows directory. You can use the example below:\n\n```yaml\nname: Deploy to GitHub Pages\non:\n  push:\n    branches:\n      - master\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    strategy:\n      matrix:\n        node-version: [14.2.0]\n    steps:\n      - uses: actions/checkout@v3\n      - name: install, build, and test\n        run: |\n          yarn install\n          yarn lint\n          yarn build\n          yarn test\n        env:\n          CI: true\n      - name: Deploy to production\n        uses: awibox/deploy-to-github-pages-action@master\n        env:\n          AUTHOR: awibox\n          BUILD_PATH: public\n          GITHUB_PAGE_NAME: awibox.github.io\n          PA_TOKEN: ${{ secrets.PA_TOKEN }}\n          USERNAME: awibox\n          EMAIL: 1931010+awibox@users.noreply.github.com\n```\n\n## Example repositories using this action\n\n- \u003chttps://github.com/awibox/awibox\u003e\n- \u003chttps://github.com/Paulracisz/react-portfolio\u003e\n- \u003chttps://github.com/ntloi95/chess-4-players-timer\u003e\n\n## Environment variables\n\n|Environment variable|Required|Description|Example|\n|--------------------|--------|-----------|-------|\n|`AUTHOR`|Required|Name of the repository owner|awibox|\n|`BUILD_PATH`|Required|The directory where the static is built| public\n|`GITHUB_PAGE_NAME`|Required|Name of the repository for GitHub Pages where the application will be collected|awibox.github.io|\n|`PA_TOKEN`|Required|GitHub Private Access Token with editing rights for repo. You can create it using [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)|${{secrets.PA_TOKEN}}|\n|`USERNAME`|Optional|The GitHub username for commits.|awibox|\n|`EMAIL`|Optional|The email that is used for commits.|1931010+awibox@users.noreply.github.com|\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawibox%2Fdeploy-to-github-pages-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fawibox%2Fdeploy-to-github-pages-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawibox%2Fdeploy-to-github-pages-action/lists"}