Merge branch '598-new-job-heroku-deploy' into 'latest'

generate_job_av:

  image: python:3.9.1-alpine

  stage: static_tests

  dependencies:

    - refresh_job_av_database

  variables:

    PIPENV_PIPFILE: tools/job_av/Pipfile

    JOB_LOGFILE: "generate_job.log"

# Changelog

All notable changes to this job will be documented in this file.

## [0.1.0] - 2022-06-16

* Initial version

 No newline at end of file

## Objective

Deploy your application to Heroku. You can use custom buildpacks depending on our needs, please check out the documentation [here](https://devcenter.heroku.com/articles/buildpacks). It use [`dpl`](https://github.com/travis-ci/dpl), which is a command line tool for deploying code, html, packages, or build artifacts to various service providers. 

## How to use it

1. Create an application on [Heroku](https://dashboard.heroku.com/new-app) and fill the application name in the `HEROKU_APP` variable.

1. Copy your API key in the `HEROKU_API_KEY` variable.

1. Copy the job URL located in the `Install` part of the right panel and add it inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

1. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

1. Well done, your job is ready to work ! 😀

## Job details

* Job name: `heroku_deploy`

* Docker image:

[`ruby:3.2-rc-buster`](https://hub.docker.com/r/_/ruby)

* Default stage: `deploy`

* When: `always`

### Variables

| Name | Description | Default |

| ---- | ----------- | ------- |

| `HEROKU_APP` <img width=100/> | The name of the Heroku application <img width=175/>| ` ` <img width=100/>|

| `HEROKU_API_KEY` | ⚠️ Sensitive variable: it should be specified in `Gitlab > CI/CD Settings`. The Heroku application key.  | ` `  |

| `ADDITIONAL_OPTIONS` | Additional [options](https://github.com/travis-ci/dpl#heroku-api) for `dpl` command | ` ` |

| `IMAGE_TAG` | The default tag for the docker image | `3.2-rc-buster`  |

### Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@GridexX](https://gitlab.com/GridexX)

 No newline at end of file

stages:

  - deploy

heroku_deploy:

    image: ruby:${IMAGE_TAG}

    stage: deploy

    variables:

      HEROKU_APP: ""

      HEROKU_API_KEY: ""

      ADDITIONAL_OPTIONS: ""

      IMAGE_TAG: 3.2-rc-buster

    script:

      - gem install dpl

      - dpl --provider=heroku --app=$HEROKU_APP --api-key=$HEROKU_API_KEY ${ADDITIONAL_OPTIONS}