https://github.com/actions/heroku

GitHub Action for interacting with Heroku
https://github.com/actions/heroku

Last synced: about 1 month ago
JSON representation

GitHub Action for interacting with Heroku

• Host: GitHub
• URL: https://github.com/actions/heroku
• Owner: actions
• License: mit
• Archived: true
• Created: 2018-10-12T16:42:16.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2020-10-14T20:48:07.000Z (about 4 years ago)
• Last Synced: 2024-09-26T17:09:21.597Z (about 2 months ago)
• Language: HCL
• Homepage:
• Size: 29.3 KB
• Stars: 178
• Watchers: 7
• Forks: 62
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GitHub Deployer for Heroku

This Action wraps the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) to enable common Heroku commands.

## Usage

An example workflow to build a docker container from source and push and release the image to an existing application on Heroku:

```

workflow "Deploy to Heroku" {

  on = "push"

  resolves = "release"

}

action "login" {

  uses = "actions/heroku@master"

  args = "container:login"

  secrets = ["HEROKU_API_KEY"]

}

action "push" {

  uses = "actions/heroku@master"

  needs = "login"

  args = "container:push -a calm-fortress-1234 web"

  secrets = ["HEROKU_API_KEY"]

}

action "release" {

  uses = "actions/heroku@master"

  needs = "push"

  args = "container:release -a calm-fortress-1234 web"

  secrets = ["HEROKU_API_KEY"]

}

```

### Secrets

* `HEROKU_API_KEY` - **Required**. The token to use for authentication with the Heroku API ([more info](https://help.heroku.com/PBGP6IDE/how-should-i-generate-an-api-key-that-allows-me-to-use-the-heroku-platform-api))

### Environment variables

* `HEROKU_APP` - **Optional**. To specify a Heroku application

## License

The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).

Container images built with this project include third party materials. See [THIRD_PARTY_NOTICE.md](THIRD_PARTY_NOTICE.md) for details.