GitHub Pages Health Check
Checks your GitHub Pages site for common DNS configuration issues
Installation
gem install github-pages-health-check
Usage
Basic Usage
> check = GitHubPages::HealthCheck::Site.new("choosealicense.com")
=> #<GitHubPages::HealthCheck::Site @domain="choosealicense.com" valid?=true>
> check.valid?
=> trueAn invalid domain
> check = GitHubPages::HealthCheck::Site.new("foo.github.com")
> check.valid?
=> false
> check.valid!
raises GitHubPages::HealthCheck::Errors::InvalidCNAMEErrorRetrieving specific checks
> check.domain.should_be_a_record?
=> true
> check.domain.a_record?
=> trueGetting checks in bulk
> check.to_hash
=> {
: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
}
> check.to_json
=> "{\"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}"Getting the reason a domain is invalid
> check = GitHubPages::HealthCheck::Site.new "developer.facebook.com"
> check.valid?
=> false
> check.reason
=> #<GitHubPages::HealthCheck::InvalidCNAME>
> check.reason.message
=> "CNAME does not point to GitHub Pages"Repository checks
Repository 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:
check = GitHubPages::HealthCheck::Site.new "github/pages-health-check", access_token: "1234You can also set OCTOKIT_ACCESS_TOKEN as an environmental variable, or via a .env file in your working directory.
