Heroku

The Heroku Action connector will trigger a build of your Heroku app.

Set up Heroku

Perform the following steps to set up the Heroku action connector:

  1. Click Configure Action Step from the left navigation panel.
  2. Click Action Step to configure third-party services.
  3. Within the Configure Action Step, click the Heroku connector.
    Click to enlarge

  4. Under Choose an Action tab, select the Trigger a Build action.
    Click to enlarge
  5. Click the + Add New Account button to select your Heroku account.
  6. Now, add a suitable Title and the API Key of your Heroku app to connect your Heroku account with Contentstack.
    Click to enlarge

    To get your Heroku app's API Key, log in to the Heroku dashboard, and perform the following steps:
    1. Click Account Settings under the user profile.
    2. Click the Account tab, and you will find your API Key.
    Click to enlarge

    Additional Resource For more information, refer to the How to generate an API Key document.

  7. Once done, click Authorize.
  8. Under the Source-blob url section, add the url where the source code of your build is present.

    Note If you are using a public GitHub repo for your source code then the url will be in the following format:

    https://api.github.com/repos/<username>/<repo_name>/tarball/<branch_name>/</branch_name></repo_name></username></repo_name></repo_name></username>

    Example:
    https://api.github.com/repos/username/samplename/tarball/master/

    For a private GitHub repo use the following format:
    https://:@api.github.com/repos/<username>/<repo_name>/tarball/<branch_name>/ </branch_name></repo_name></username></token></user_name>

    Example:
    https://username:[email protected]/repos/username/samplename/tarball/master/

  9. Under the App name/ id section, select the app that you have created in Heroku.
  10. You can mention a Version for your build. This is an optional step which will help you keep track of the latest version for your build.
  11. Finally, click on the toggle button if you want to Hide optional fields and then click Proceed.
    Click to enlarge

  12. Click Test Action to test if a build is created in Heroku. In the output section, you can view the status of your build.
    Click to enlarge

  13. Once set, click Save and Exit.
    Click to enlarge


    The action will deploy a build in your Heroku project. You can check the build and open the respective app you deployed using the Heroku connector.
    Click to enlarge

This sets up the Heroku action connector.