README.md

GitHub Action: Check - URL - Ping

---

Overview

Action to run ping check on given URL.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/check/url-ping@642cdb54493d05debdc1394f4bfd7365f82e7bf1 # 0.18.2
  with:
    # The URL to check.
    # This input is required.
    url: ""

    # Whether to follow redirects.
    # Default: `false`
    follow-redirect: "false"

    # Timeout in seconds for the full URL check process.
    # Default: `60`
    timeout: "60"

    # Total number of attempts allowed for the URL check process.
    # Default: `3`
    retries: "3"

    # Expected HTTP status codes. Comma separated list.
    # Default: `200`
    expected-statuses: "200"

    # Optional Authorization header used to access private URLs.
    # Examples: `Bearer xxx...`, `token xxx...`
    authorization: ""

Inputs

Input	Description	Required	Default
url	The URL to check.	true	-
follow-redirect	Whether to follow redirects.	false	false
timeout	Timeout in seconds for the full URL check process.	false	60
retries	Total number of attempts allowed for the URL check process.	false	3
expected-statuses	Expected HTTP status codes. Comma separated list.	false	200
authorization	Optional Authorization header used to access private URLs.	false	-
	Examples: Bearer xxx..., token xxx...

Outputs

Output	Description
status-code	The HTTP status code returned by the URL check.
attempt-count	Total number of attempts performed before completion.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.