Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check

GitHub Action

URL Health Check

v2

URL Health Check

check

URL Health Check

Ping given URL (with curl) for a post-deploy check. With redirect and retrying capabilities

Installation

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

 
              
- name: URL Health Check

              
  uses: Jtalk/url-health-check-action@v2
Learn more about this action in Jtalk/url-health-check-action

Choose a version

URL health check action

A cURL-based post-deploy health check with build-in redirect & retry. An quick & easy way to verify a deployment.

steps:
  - name: Check the deployed service URL
    uses: jtalk/url-health-check-action@v2
    with:
      # Check the following URLs one by one sequentially
      url: https://example.com|http://example.com
      # Follow redirects, or just report success on 3xx status codes
      follow-redirect: false # Optional, defaults to "false"
      # Fail this action after this many failed attempts
      max-attempts: 3 # Optional, defaults to 1
      # Delay between retries
      retry-delay: 5s # Optional, only applicable to max-attempts > 1
      # Retry all errors, including 404. This option might trigger curl upgrade.
      retry-all: false # Optional, defaults to "false"

The action will fail if any of the URLs reports either 4xx or 5xx status codes.