{"id":17183588,"url":"https://github.com/nicholasgriffintn/github-branch-deployment-action","last_synced_at":"2026-02-12T11:12:26.064Z","repository":{"id":37010598,"uuid":"406835627","full_name":"nicholasgriffintn/github-branch-deployment-action","owner":"nicholasgriffintn","description":"This is an action that will deploy a folder to a GitHub branch","archived":false,"fork":false,"pushed_at":"2023-04-26T10:04:05.000Z","size":4165,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T22:14:40.259Z","etag":null,"topics":["action","deployment","publishing","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/github-branch-deployer","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicholasgriffintn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-15T15:59:14.000Z","updated_at":"2023-07-27T15:01:06.000Z","dependencies_parsed_at":"2023-01-05T05:01:42.281Z","dependency_job_id":null,"html_url":"https://github.com/nicholasgriffintn/github-branch-deployment-action","commit_stats":{"total_commits":53,"total_committers":6,"mean_commits":8.833333333333334,"dds":0.6603773584905661,"last_synced_commit":"8e4ce144a5fc514c19d7986adaefd06d11dd3ca3"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicholasgriffintn%2Fgithub-branch-deployment-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicholasgriffintn%2Fgithub-branch-deployment-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicholasgriffintn%2Fgithub-branch-deployment-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicholasgriffintn%2Fgithub-branch-deployment-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicholasgriffintn","download_url":"https://codeload.github.com/nicholasgriffintn/github-branch-deployment-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247440235,"owners_count":20939212,"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","deployment","publishing","typescript"],"created_at":"2024-10-15T00:41:00.592Z","updated_at":"2026-02-12T11:12:21.038Z","avatar_url":"https://github.com/nicholasgriffintn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action for deploying a build to a branch\n\nThe purpose of this action is to work alongside build processes that clone a built version of your project from a branch, allowing you to extend your GitHub Action to push the distribution of your application to a seperate branch on the same repo or another repo that you give it access to.\n\n[![Latest Test](https://github.com/nicholasgriffintn/github-branch-deployment-action/actions/workflows/ci-test.yml/badge.svg)](https://github.com/nicholasgriffintn/github-branch-deployment-action/actions/workflows/ci-test.yml)\n\nYou can use it in your action like this:\n\n```yaml\nname: Build and Push to Serv Content\n\non:\n  push:\n    branches: [main]\n\njobs:\n  serv_content:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      - name: Setup Node\n        uses: actions/setup-node@v1\n        with:\n          node-version: 12.x\n\n      - name: Install\n        run: npm ci\n\n      - name: Test\n        run: npm run test\n\n      - name: Build\n        run: npm run build\n\n      - name: Push\n        uses: nicholasgriffintn/github-branch-deployment-action@0.0.1\n        env:\n          GITHUB_TOKEN: ${{ secrets.DEPLOYMENT_GITHUB_TOKEN }}\n          BRANCH: serv_content\n          FOLDER: dist\n          MESSAGE: 'Build: ({sha}) {msg}'\n```\n\nHere's further explanation on those inputs:\n\n| name         | value  | default                | description                                                                                                                                                                                                                                                                                                                                                                                          |\n| ------------ | ------ | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| GITHUB_TOKEN | string | ${{ github.token }}    | This is used to allow the action to commmunicate with your repos. You can use the standard [workflow token](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) or use a [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token). |\n| REPO         | string | 'self'                 | By default, this will use the same repo that the action is contained within, you can add a different repo url here if you would like to push elsewhere.                                                                                                                                                                                                                                              |\n| BRANCH       | string | null                   | You are required to enter a branch here, this is the branch that the action will push changes to.                                                                                                                                                                                                                                                                                                    |\n| FOLDER       | string | '.'                    | This is the folder that should be pushed to your repo and branch, by default, it uses the root folder.                                                                                                                                                                                                                                                                                               |\n| MESSAGE      | string | 'Build: ({sha}) {msg}' | This is the message that is used for the commit, use `{sha}` and `{msg}` to insert the sha and msg of the commit that triggered the build.                                                                                                                                                                                                                                                           |\n\n## Config data\n\n```javascript\n{\n  GITHUB_TOKEN: '***',\n  CI: 'true',\n  GITHUB_WORKFLOW: \"Test the action's deployments to a new branch\",\n  GITHUB_RUN_ID: '1239320120',\n  GITHUB_RUN_NUMBER: '3',\n  GITHUB_JOB: 'test',\n  GITHUB_ACTION: '__self',\n  GITHUB_ACTION_PATH: undefined,\n  GITHUB_ACTIONS: 'true',\n  GITHUB_ACTOR: 'nicholasgriffintn',\n  GITHUB_REPOSITORY: 'nicholasgriffintn/github-branch-deployment-action',\n  GITHUB_EVENT_NAME: 'push',\n  GITHUB_EVENT_PATH: '/home/runner/work/_temp/_github_workflow/event.json',\n  GITHUB_WORKSPACE: '/home/runner/work/github-branch-deployment-action/github-branch-deployment-action',\n  GITHUB_SHA: '893b0f9ed05157427e0ec22fd117a5ee0377e3f2',\n  GITHUB_REF: 'refs/heads/main',\n  GITHUB_HEAD_REF: '',\n  GITHUB_BASE_REF: '',\n  GITHUB_SERVER_URL: 'github.com',\n  GITHUB_API_URL: 'api.github.com',\n  GITHUB_GRAPHQL_URL: 'api.github.com/graphql',\n  RUNNER_OS: 'Linux',\n  RUNNER_TEMP: '/home/runner/work/_temp',\n  RUNNER_TOOL_CACHE: '/opt/hostedtoolcache',\n  TEMP_DIR_NAME: 'github-branch-deployment-action-',\n  REPO: 'self',\n  BRANCH: 'test',\n  FOLDER: 'dist',\n  MESSAGE: 'Build: ({sha}) {msg}',\n  URL: '***github.com/nicholasgriffintn/github-branch-deployment-action.git'\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicholasgriffintn%2Fgithub-branch-deployment-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicholasgriffintn%2Fgithub-branch-deployment-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicholasgriffintn%2Fgithub-branch-deployment-action/lists"}