{"id":16461566,"url":"https://github.com/stringbean/docker-healthcheck-action","last_synced_at":"2025-08-13T01:49:26.670Z","repository":{"id":65161894,"uuid":"447603547","full_name":"stringbean/docker-healthcheck-action","owner":"stringbean","description":"GitHub Action for checking \u0026 waiting for Docker container status","archived":false,"fork":false,"pushed_at":"2024-02-06T14:42:09.000Z","size":1101,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-30T17:53:43.039Z","etag":null,"topics":["ci","docker","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stringbean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-01-13T13:09:43.000Z","updated_at":"2025-06-19T20:53:35.000Z","dependencies_parsed_at":"2024-02-06T15:57:41.448Z","dependency_job_id":null,"html_url":"https://github.com/stringbean/docker-healthcheck-action","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"3333ffbde6a20447793722a29c1d0237ef2700bc"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/stringbean/docker-healthcheck-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdocker-healthcheck-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdocker-healthcheck-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdocker-healthcheck-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdocker-healthcheck-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stringbean","download_url":"https://codeload.github.com/stringbean/docker-healthcheck-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdocker-healthcheck-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270166015,"owners_count":24538440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-12T02:00:09.011Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","docker","github-actions"],"created_at":"2024-10-11T11:08:41.085Z","updated_at":"2025-08-13T01:49:26.588Z","avatar_url":"https://github.com/stringbean.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Container Health Check\n\nGitHub Action for checking the status of a Docker container.\n\n## Usage\n\n### Get the status of a container\n\nTo query the status of a container, pass the container name (or id) to the action:\n\n```yaml\njobs:\n  test:\n    steps:\n      - name: Get container status\n        uses: stringbean/docker-healthcheck-action@v1\n        id: missing-container\n        with:\n          container: unknown\n      - run: echo \"Container is ${{ steps.missing-container.outputs.status  }}\"\n```\n\nThis will output \"Container is not-running\".\n\n### Waiting for a container to become healthy\n\nTo wait for a container to become healthy, pass in the required status \u0026\n`require-healthy: true`:\n\n```yaml\njobs:\n  test:\n    steps:\n      - name: Start container\n        run: docker run -d --rm --name hello-world crccheck/hello-world\n      - name: Wait for container\n        uses: stringbean/docker-healthcheck-action@v1\n        with:\n          container: hello-world\n          wait-time: 50\n          require-status: running\n          require-healthy: true\n```\n\nThis will start the `hello-world` container and wait for it to pass a health\ncheck. If the container takes longer than 60 seconds to become healthy it will\nfail the build.\n\n## Configuration\n\n### Inputs\n\n| Name              | Description                                                                          | Default           |\n| ----------------- | ------------------------------------------------------------------------------------ | ----------------- |\n| `container`       | Name of the container to check                                                       | _none_ (required) |\n| `require-status`  | Container status to expect/wait for.                                                 | _none_            |\n| `require-healthy` | Require (or wait for) the container to be healthy.                                   | `false`           |\n| `wait-time`       | Maximum number of time to wait for the container to reach the required state/health. | `0` (seconds)     |\n\n### Outputs\n\n| Name      | Description                       | Examples               |\n| --------- | --------------------------------- | ---------------------- |\n| `status`  | Current status of the container.  | `not-found`, `running` |\n| `healthy` | Whether the container is healthy. | `true`, `false`        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstringbean%2Fdocker-healthcheck-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstringbean%2Fdocker-healthcheck-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstringbean%2Fdocker-healthcheck-action/lists"}