https://github.com/envato/heroku-container-deploy-buildkite-plugin
Deploy pre-built docker images to Heroku using Heroku Container Registry
https://github.com/envato/heroku-container-deploy-buildkite-plugin
buildkite-plugin
Last synced: 5 months ago
JSON representation
Deploy pre-built docker images to Heroku using Heroku Container Registry
- Host: GitHub
- URL: https://github.com/envato/heroku-container-deploy-buildkite-plugin
- Owner: envato
- License: mit
- Created: 2021-12-20T03:59:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-29T04:58:21.000Z (almost 4 years ago)
- Last Synced: 2026-01-21T17:40:53.976Z (5 months ago)
- Topics: buildkite-plugin
- Language: Shell
- Homepage:
- Size: 60.5 KB
- Stars: 4
- Watchers: 39
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Heroku Container Deploy
Deploy pre-built docker images, typically with [docker-compose-buildkite-plugin](https://github.com/buildkite-plugins/docker-compose-buildkite-plugin), to using the Heroku Container Registry. It follows the official recommended steps [for Docker deploys on Heroku](https://devcenter.heroku.com/articles/container-registry-and-runtime). See [ecr-buildkite-plugin](https://github.com/buildkite-plugins/ecr-buildkite-plugin) for authenticating with AWS ECR.
## Design Decision
[Heroku API](https://devcenter.heroku.com/articles/container-registry-and-runtime#api) is favoured over depending on the Heroku CLI. This helps to avoid problems with transitive npm dependencies causing CI blockage at scale.
## Example
Deploy a pre-built images from ECR to heroku container registry.
```yml
steps:
- label: ":heroku: Deploy my-app app (web)"
plugins:
- envato/heroku-container-deploy#v1.3.0:
app: my-app
process-type-images:
- web:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-web-${BUILDKITE_COMMIT}
```
Deploy multiple pre-built images from ECR to heroku container registry.
```yml
steps:
- label: ":heroku: Deploy my-app app (web and worker)"
plugins:
- envato/heroku-container-deploy#v1.3.0:
app: my-app
process-type-images:
- web:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-web-${BUILDKITE_COMMIT}
- worker:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-worker-${BUILDKITE_COMMIT}
```
Deploy multiple pre-built images including a [Release Phase](https://devcenter.heroku.com/articles/container-registry-and-runtime#release-phase) from ECR to heroku container registry. Plugin will stream the release output to Buildkite logs.
```yml
steps:
- label: ":heroku: Deploy my-app app (web, worker and release)"
plugins:
- envato/heroku-container-deploy#v1.3.0:
app: my-app
process-type-images:
- web:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-web-${BUILDKITE_COMMIT}
- worker:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-worker-${BUILDKITE_COMMIT}
- release:XXXXXXXXXXXX.dkr.ecr.us-east-1.amazonaws.com/my-repo:heroku-release-${BUILDKITE_COMMIT}
```
## Configuration
### `app` (Required, string)
Heroku app name
### `key-name` (Optional, string)
The name of the environment variable that contains the Heroku API key. Defaults to `HEROKU_API_KEY`
### `process-type-images` (Required, Array of string)
List of process types and their image repository to deploy.
```
::
```
### `releasing` (Optional, Array of string)
List of process type names to be released. It will allays pull, tag and push all images, but it will only patch the Heroku Formation API with these images.
Default: All process types in `process-type-images` except one named `migrations`
## Developing
Testing
```shell
docker-compose run --rm tests
```
Linting
```shell
docker-compose run --rm lint
```