https://github.com/hatchboxio/github-hatchbox-deploy-action
Send deployment notifications to Hatchbox via GitHub Actions
https://github.com/hatchboxio/github-hatchbox-deploy-action
actions ci github-actions hatchbox rails ruby ruby-on-rails
Last synced: 12 months ago
JSON representation
Send deployment notifications to Hatchbox via GitHub Actions
- Host: GitHub
- URL: https://github.com/hatchboxio/github-hatchbox-deploy-action
- Owner: hatchboxio
- Created: 2020-10-20T19:24:47.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-15T18:18:15.000Z (over 2 years ago)
- Last Synced: 2025-04-16T05:32:58.936Z (about 1 year ago)
- Topics: actions, ci, github-actions, hatchbox, rails, ruby, ruby-on-rails
- Language: Shell
- Homepage: https://hatchbox.io
- Size: 27.3 KB
- Stars: 22
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Hatchbox.io Deploy Action
Trigger Hatchbox.io app deployments.
For Hatchbox Classic users, see [v1]().
#### Inputs
Use these inputs to customise the action.
Input Name | Default | Required? | Description
------------ | ------------- | ------------ | -------------
deploy_key | N/A | Y | Your Hatchbox.io app's Deploy Key.
sha | ${{ github.sha }} | N | The commit sha to deploy. Default's to the sha that triggered the GitHub Action.
## Usage
Set `HATCHBOX_DEPLOY_KEY` in your GitHub Secrets. You can find the Deploy Key in the URL on the App's Repository tab in Hatchbox.io.
#### Example
```yaml
# .github/workflows/deploy.yml
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: hatchboxio/github-hatchbox-deploy-action@v2
with:
deploy_key: ${{ secrets.HATCHBOX_DEPLOY_KEY }}
```