{"id":15048222,"url":"https://github.com/github/pages-health-check","last_synced_at":"2026-03-09T20:01:36.891Z","repository":{"id":19000275,"uuid":"22222472","full_name":"github/pages-health-check","owner":"github","description":"Checks your GitHub Pages site for common DNS configuration issues","archived":false,"fork":false,"pushed_at":"2026-02-17T17:39:17.000Z","size":3019,"stargazers_count":153,"open_issues_count":7,"forks_count":45,"subscribers_count":307,"default_branch":"master","last_synced_at":"2026-02-17T22:19:27.444Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-07-24T17:17:54.000Z","updated_at":"2026-02-17T17:39:19.000Z","dependencies_parsed_at":"2024-01-22T23:28:25.098Z","dependency_job_id":"59a85cfa-77b4-4e01-afb3-5fc2d7b74124","html_url":"https://github.com/github/pages-health-check","commit_stats":{"total_commits":382,"total_committers":28,"mean_commits":"13.642857142857142","dds":0.6099476439790577,"last_synced_commit":"120cc09f776f42e9ac4e9d87e66a042819b8aa32"},"previous_names":["github/github-pages-health-check"],"tags_count":69,"template":false,"template_full_name":null,"purl":"pkg:github/github/pages-health-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fpages-health-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fpages-health-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fpages-health-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fpages-health-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/pages-health-check/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fpages-health-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29621892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T13:04:20.082Z","status":"ssl_error","status_checked_at":"2026-02-19T13:03:33.775Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-09-24T21:09:28.814Z","updated_at":"2026-03-09T20:01:36.842Z","avatar_url":"https://github.com/github.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Pages Health Check\n\n*Checks your GitHub Pages site for common DNS configuration issues*\n\n[![Build Status](https://github.com/github/pages-health-check/actions/workflows/push-cibuild.yml/badge.svg)](https://github.com/github/pages-health-check/actions/workflows/push-cibuild.yml)\n[![Gem Version](https://badge.fury.io/rb/github-pages-health-check.svg)](http://badge.fury.io/rb/github-pages-health-check)\n\n## Installation\n\n`gem install github-pages-health-check`\n\n## Usage\n\n### Basic Usage\n\n```ruby\n\u003e check = GitHubPages::HealthCheck::Site.new(\"choosealicense.com\")\n=\u003e #\u003cGitHubPages::HealthCheck::Site @domain=\"choosealicense.com\" valid?=true\u003e\n\u003e check.valid?\n=\u003e true\n```\n\n### An invalid domain\n\n```ruby\n\u003e check = GitHubPages::HealthCheck::Site.new(\"foo.github.com\")\n\u003e check.valid?\n=\u003e false\n\u003e check.valid!\nraises GitHubPages::HealthCheck::Errors::InvalidCNAMEError\n```\n\n\n### Retrieving specific checks\n\n``` ruby\n\u003e check.domain.should_be_a_record?\n=\u003e true\n\u003e check.domain.a_record?\n=\u003e true\n```\n\n### Getting checks in bulk\n\n```ruby\n\u003e check.to_hash\n=\u003e {\n :cloudflare_ip?=\u003efalse,\n :old_ip_address?=\u003efalse,\n :a_record?=\u003etrue,\n :cname_record?=\u003efalse,\n :valid_domain?=\u003etrue,\n :apex_domain?=\u003etrue,\n :should_be_a_record?=\u003etrue,\n :pointed_to_github_user_domain?=\u003efalse,\n :pointed_to_github_pages_ip?=\u003efalse,\n :pages_domain?=\u003efalse,\n :valid?=\u003etrue\n}\n\u003e check.to_json\n=\u003e \"{\\\"cloudflare_ip?\\\":false,\\\"old_ip_address?\\\":false,\\\"a_record?\\\":true,\\\"cname_record?\\\":false,\\\"valid_domain?\\\":true,\\\"apex_domain?\\\":true,\\\"should_be_a_record?\\\":true,\\\"pointed_to_github_user_domain?\\\":false,\\\"pointed_to_github_pages_ip?\\\":false,\\\"pages_domain?\\\":false,\\\"valid?\\\":true}\"\n```\n\n### Getting the reason a domain is invalid\n\n```ruby\n\u003e check = GitHubPages::HealthCheck::Site.new \"developer.facebook.com\"\n\u003e check.valid?\n=\u003e false\n\u003e check.reason\n=\u003e #\u003cGitHubPages::HealthCheck::InvalidCNAME\u003e\n\u003e check.reason.message\n=\u003e \"CNAME does not point to GitHub Pages\"\n```\n\n### Repository checks\n\nRepository checks require a personal access or OAuth token with `repo` or scope. This can be passed as the second argument to the Site or Repository constructors like so:\n\n```ruby\ncheck = GitHubPages::HealthCheck::Site.new \"github/pages-health-check\", access_token: \"1234\n```\n\nYou can also set `OCTOKIT_ACCESS_TOKEN` as an environmental variable, or via a `.env` file in your working directory.\n\n### Command Line\n\n```\n./script/check pages.github.com\n\nhost: pages.github.com\nuri: https://pages.github.com/\nnameservers: :default\ndns_resolves?: true\nproxied?: false\ncloudflare_ip?: false\nfastly_ip?: false\nold_ip_address?: false\na_record?: false\ncname_record?: true\nmx_records_present?: false\nvalid_domain?: true\napex_domain?: false\nshould_be_a_record?: false\ncname_to_github_user_domain?: true\ncname_to_pages_dot_github_dot_com?: false\ncname_to_fastly?: false\npointed_to_github_pages_ip?: false\nnon_github_pages_ip_present?: false\npages_domain?: true\nserved_by_pages?: true\nvalid?: true\nreason:\nhttps?: true\nenforces_https?: true\nhttps_error:\nhttps_eligible?: true\ncaa_error:\ndns_zone_soa?: false\ndns_zone_ns?: false\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fpages-health-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fpages-health-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fpages-health-check/lists"}