Skip to content
git-pull-request

GitHub Action

Heroku Review App Deployment Status

v1.4.0 Latest version
Use latest version
git-pull-request

Heroku Review App Deployment Status

A Github Action to test the deployment status of a Heroku Review App

Installation

Copy and paste the following snippet into your .yml file.

- name: Heroku Review App Deployment Status
  uses: teamniteo/reviewapps-deploy-status@v1.4.0
Learn more about this action in teamniteo/reviewapps-deploy-status
Choose a version

Heroku Review Apps deployment status

CircleCI GitHub marketplace

A Github Action that tests the deployment status of a Heroku Review App.

Note: This Action is recommended for small projects. For medium to large projects, a different approach is recommended to save compute minutes. Check this Blog Post for detailed process of the approach.

Usage

  • Include the action in the workflow
    name: Review App Test
    
    on:
        pull_request:
            branches:
            - master
    
    jobs:
      review-app-test:
    
        runs-on: ubuntu-latest
        
        steps:
        - name: Run review-app test
          id: review_app_test  # `id` value is used to refer the outputs from the corresponding action 
          uses: teamniteo/reviewapps-deploy-status@v1.4.0
          env:
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          with:
            # Checks to be performed, default is all the checks
            checks: build, response
    
            # Delay for the application to be built in Heroku, default is 5 seconds
            build_time_delay: 5
    
            # Delay for the application to load and start serving, default is 5 seconds
            load_time_delay: 5
    
            # Interval for the repeating checks, default is 10 seconds
            interval: 10
    
            # Acceptable responses for the response check, default is 200
            accepted_responses: 200
    
            # Max time to be spent retrying for the build check, default is 120
            deployments_timeout: 120
    
            # Max time to be spent retrying for the response check, default is 120
            publish_timeout: 120
    
        # `steps.review_app_test.outputs.review_app_url` must be used in workflow to fetch the Review App URL 
        - name: Check review_app_url
          run: |
            echo "Outputs :"
            echo "- App name: ${{ steps.review_app_test.outputs.review_app_name }}"
            echo "- App url: ${{ steps.review_app_test.outputs.review_app_url }}"

Note: Work flow should include pull_request event.

  • GITHUB_TOKEN is required to communicate with Github Deployment API. Default token provided by Github can be used.

  • Input description:
    All the inputs are optional. If needed, must be provided from the workflow.

    Name Description Default
    checks Comma separated list of checks to be performed build, response
    build_time_delay Delay for the application to be built in Heroku 5
    load_time_delay Delay for the application to load and start serving 5
    interval Interval for the repeating checks (in seconds) 10
    accepted_responses Acceptable responses for the response check (comma separated) 200
    deployments_timeout Max time to be spent retrying for the build check (in seconds) 120
    publish_timeout Max time to be spent retrying for the response check (in seconds) 120

Workflow

Initialize
├── Build time delay
├── Fetch build data
├── Is `build` check included in the `checks`?
│   ├── Yes
│   │   └── Is the build status a `success`?
│   │       ├── Yes
│   │       │   └── Continue
│   │       └── No
│   │           └── Are we past the `deployments_timeout`?
│   │               ├── Yes
│   │               │   └── Fail
│   │               └── No
│   │                   └── Repeat from `Fetch build data`
│   └── No
│       └── Continue
├── Load time delay
├── Is `response` check included in the `checks`?
│   ├── Yes
│   │   ├── Do an HTTP request to the app URL.
│   │   └── Is the HTTP response in the `accepted_responses`?
│   │       └── No
│   │           └── Are we past the `publish_timeout`?
│   │               ├── Yes
│   │               │   └── Fail
│   │               └── No
│   │                   └── Repeat from `Do an HTTP request to the app URL`
│   └── No
│       └── Continue
└── Done (success)

Local Development

  • Create a Python virtual environment(version > 3.6).
  • Activate the environment.
  • Install the development dependencies:
    pip install -r requirements-dev.txt
  • Make changes.
  • Test the changes:
    make tests
  • Make sure that coverage is 100%.