https://github.com/remarkablemark/gitploy-action
🚀 GitHub Action to deploy a directory to a remote Git branch.
https://github.com/remarkablemark/gitploy-action
branch deploy deployment git github-action github-actions github-pages release
Last synced: 5 months ago
JSON representation
🚀 GitHub Action to deploy a directory to a remote Git branch.
- Host: GitHub
- URL: https://github.com/remarkablemark/gitploy-action
- Owner: remarkablemark
- License: mit
- Created: 2024-09-28T18:49:39.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-15T01:09:56.000Z (10 months ago)
- Last Synced: 2025-07-19T23:35:22.118Z (5 months ago)
- Topics: branch, deploy, deployment, git, github-action, github-actions, github-pages, release
- Homepage: https://github.com/marketplace/actions/gitploy-action
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gitploy-action
[](https://github.com/remarkablemark/gitploy-action/releases)
[](https://github.com/remarkablemark/gitploy-action/actions/workflows/test.yml)
[](https://opensource.org/licenses/MIT)
🚀 GitHub Action to deploy a directory to a remote Git branch. See [demo](https://remarkablemark.org/gitploy-action/).
> [!NOTE]
>
> If you see the error:
>
> ```
> remote: Permission to ... denied to ....
> fatal: unable to access 'https://github.com/...': The requested URL returned error: 403
> ```
>
> Enable **Settings** > **Actions** > **General** > **Workflow permissions** > **Read and write permissions**
## Quick Start
```yaml
# .github/workflows/deploy.yml
on: push
jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
# insert build step
# ...
- name: Deploy to GitHub Pages
uses: remarkablemark/gitploy-action@v1
with:
directory: build
```
## Usage
Commit and push `dist` to the remote `gh-pages` branch:
```yaml
- uses: remarkablemark/gitploy-action@v1
with:
directory: dist
branch: gh-pages
```
See [action.yml](https://github.com/remarkablemark/gitploy-action/blob/master/action.yml)
## Inputs
### `directory`
**Required**: The directory of the build files.
```yaml
- uses: remarkablemark/gitploy-action@v1
with:
directory: build
```
### `branch`
**Optional**: The remote Git branch to deploy to. Defaults to `gh-pages`:
```yaml
- uses: remarkablemark/gitploy-action@v1
with:
directory: build
branch: gh-pages
```
### `token`
**Optional**: The GitHub token. Defaults to `GITHUB_TOKEN`:
```yaml
- uses: remarkablemark/gitploy-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
## License
[MIT](LICENSE)