github-pages-health-check 1.18.1 → 1.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c192823fd967f8d554b5eaa42b7e3eeac0a59a0456859f0617e1e5c44b9073c
-  data.tar.gz: 69f956e87a2bc17ea4a64ef3aa01f29215bd0fe8c9cccacd32275a16bd6be4bd
+  metadata.gz: 9e2a387d18201b5732790cea5c70f84c736eb04433cb66cf8715b7afd263bbb7
+  data.tar.gz: c9ccd398d02d8d6a2f4b372bf022cb75688178951cca0fc0f0616cf7078c4fc0
 SHA512:
-  metadata.gz: '0489d4d0a0d3df987f2cd47d414afca1933ccc2391b9d323ce17c8d8f3d0fe140244cca097689e913b5d6f5e7d7e7462628fed3c2f3d4eb2419340c87f0f3c76'
-  data.tar.gz: cb3f76bc01a5e55bdbab02072f749480787af86ee37e609c218fb38552835f2ce4e8292c0fb6b54e0eed4196969d0fdbe64f2c861aa005bb01df3870256cf110
+  metadata.gz: 20d385527764b7326b390244b38e44b2aa426748244d51e64feef83200111053efc3fe52a9cf55e0f523df27ddeaf2a24e1df15ae702a1948e2fcede15ba254d
+  data.tar.gz: 55bee6916048119777f9321cfe29a496317d855e6e428b185244c97b6ee1d77b23d16ca63be53e145a3467a94cf62858bace2c48ed0aade07c38d90000c1c274

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Automatically add our team to each pull request in this repo
+* @github/pages-reviewers

data/.github/dependabot.yml

@@ -1,15 +1,20 @@
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "10:00"
-    timezone: Europe/Vienna
-  pull-request-branch-name:
-    separator: "-"
-  open-pull-requests-limit: 99
-  allow:
-  - dependency-type: direct
-  - dependency-type: indirect
-  rebase-strategy: disabled
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "10:00"
+      timezone: Europe/Vienna
+    pull-request-branch-name:
+      separator: "-"
+    open-pull-requests-limit: 99
+    allow:
+      - dependency-type: direct
+      - dependency-type: indirect
+    rebase-strategy: disabled
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly

data/.github/workflows/pages-gem.yml

@@ -0,0 +1,27 @@
+name: Publish Gem
+
+on:
+  release:
+    types: [released]
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999 # v1.191.0
+        with:
+          ruby-version: '3.2'
+      - name: Build gem
+        run: |
+          gem build github-pages-health-check.gemspec
+      - name: Publish gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.PAGES_GEM_PUBLISHING }}
+        run: |
+          gem push github-pages-health-check-*.gem

data/.github/workflows/push-cibuild.yml

@@ -1,16 +1,18 @@
 on: push
-name: cibuild on push
+name: "GitHub Pages Health Check Tests"
+permissions:
+  contents: read
 jobs:
   build:
     name: "GitHub Pages Health Check Tests"
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '3.0'
+          - '3.1'
+          - '3.2'
     steps:
     - uses: actions/checkout@master
     - name: script/cibuild-docker

data/.rubocop.yml

@@ -17,7 +17,7 @@
 #
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   Exclude:
     - 'bin/**/*'
     - 'script/**/*'

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2

data/Gemfile

@@ -8,6 +8,7 @@ group :development do
   gem "pry", "~> 0.10"
   gem "pry-byebug"
   gem "rspec", "~> 3.0"
+  gem "rspec-retry", "~> 0.6"
   gem "rubocop", "~> 0.52"
   gem "webmock", "~> 3.8"
 end

data/README.md

@@ -2,7 +2,8 @@
 
 *Checks your GitHub Pages site for common DNS configuration issues*
 
-[![Build Status](https://travis-ci.org/github/pages-health-check.svg)](https://travis-ci.org/github/pages-health-check) [![Gem Version](https://badge.fury.io/rb/github-pages-health-check.svg)](http://badge.fury.io/rb/github-pages-health-check)
+[![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)
+[![Gem Version](https://badge.fury.io/rb/github-pages-health-check.svg)](http://badge.fury.io/rb/github-pages-health-check)
 
 ## Installation
 

data/github-pages-health-check.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency("addressable", "~> 2.3")
   s.add_dependency("dnsruby", "~> 1.60")
-  s.add_dependency("octokit", "~> 4.0")
-  s.add_dependency("public_suffix", ">= 3.0", "< 5.0")
+  s.add_dependency("octokit", ">= 4", "< 10")
+  s.add_dependency("public_suffix", ">= 3.0", "< 7.0")
   s.add_dependency("typhoeus", "~> 1.3")
 end

data/lib/github-pages-health-check/domain.rb

@@ -91,7 +91,7 @@ module GitHubPages
         host uri nameservers dns_resolves? proxied? cloudflare_ip?
         fastly_ip? old_ip_address? a_record? aaaa_record? a_record_present? aaaa_record_present?
         cname_record? mx_records_present? valid_domain? apex_domain?
-        should_be_a_record? cname_to_github_user_domain?
+        should_be_a_record? cname_to_github_user_domain? cname_to_domain_to_pages?
         cname_to_pages_dot_github_dot_com? cname_to_fastly?
         pointed_to_github_pages_ip? non_github_pages_ip_present? pages_domain?
         served_by_pages? valid? reason valid_domain? https?
@@ -160,7 +160,7 @@ module GitHubPages
       end
 
       # Is this a valid domain that PublicSuffix recognizes?
-      # Used as an escape hatch to prevent false positives on DNS checkes
+      # Used as an escape hatch to prevent false positives on DNS checks
       def valid_domain?
         return @valid if defined? @valid
 
@@ -170,7 +170,7 @@ module GitHubPages
                                      :ignore_private => true)
       end
 
-      # Is this domain an apex domain, meaning a CNAME would be innapropriate
+      # Is this domain an apex domain, meaning a CNAME would be inappropriate
       def apex_domain?
         return @apex_domain if defined?(@apex_domain)
 
@@ -202,7 +202,7 @@ module GitHubPages
       end
 
       #
-      # Does the domain have assoicated NS records?
+      # Does the domain have associated NS records?
       #
       def dns_zone_ns?
         return @ns_records if defined?(@ns_records)
@@ -243,10 +243,20 @@ module GitHubPages
         cname? && !cname_to_pages_dot_github_dot_com? && cname.pages_domain?
       end
 
+      # Check if the CNAME points to a Domain that points to pages
+      # e.g. CNAME -> Domain -> Pages
+      def cname_to_domain_to_pages?
+        a_record_to_pages = dns.select { |d| d.type == Dnsruby::Types::A && d.name.to_s == host }.first
+
+        return false unless a_record_to_pages && cname? && !cname_to_pages_dot_github_dot_com? && @www_cname
+
+        CURRENT_IP_ADDRESSES.include?(a_record_to_pages.address.to_s.downcase)
+      end
+
       # Is the given domain a CNAME to pages.github.(io|com)
       # instead of being CNAME'd to the user's subdomain?
       #
-      # domain - the domain to check, generaly the target of a cname
+      # domain - the domain to check, generally the target of a cname
       def cname_to_pages_dot_github_dot_com?
         cname? && cname.pages_dot_github_dot_com?
       end
@@ -273,7 +283,7 @@ module GitHubPages
 
       # Is this domain owned by GitHub?
       def github_domain?
-        !!host.downcase.end_with?("github.com")
+        host.downcase.eql?("github.com") || host.downcase.end_with?(".github.com")
       end
 
       # Is the host our Fastly CNAME?
@@ -304,6 +314,7 @@ module GitHubPages
         return true if cloudflare_ip?
         return false if pointed_to_github_pages_ip?
         return false if cname_to_github_user_domain?
+        return false if cname_to_domain_to_pages?
         return false if cname_to_pages_dot_github_dot_com?
         return false if cname_to_fastly? || fastly_ip?
 
@@ -399,9 +410,16 @@ module GitHubPages
         cnames = dns.take_while { |answer| answer.type == Dnsruby::Types::CNAME }
         return if cnames.empty?
 
+        www_cname(cnames.last)
         @cname ||= Domain.new(cnames.last.cname.to_s)
       end
 
+      # Check if we have a 'www.' CNAME that matches the domain
+      def www_cname(cname)
+        @www_cname ||= cname.name.to_s.start_with?("www.") &&
+          cname.name.to_s.end_with?(cname.domainname.to_s)
+      end
+
       def mx_records_present?
         return unless dns?
 
@@ -454,8 +472,7 @@ module GitHubPages
         return false if host.include?("_")
 
         # Must be a CNAME or point to our IPs.
-        # Only check the one domain if a CNAME. Don't check the parent domain.
-        return true if cname_to_github_user_domain?
+        return true if cname_to_github_user_domain? || cname_to_domain_to_pages?
 
         # Check CAA records for the full domain and its parent domain.
         pointed_to_github_pages_ip? && caa.lets_encrypt_allowed?

data/lib/github-pages-health-check/version.rb

@@ -2,6 +2,6 @@
 
 module GitHubPages
   module HealthCheck
-    VERSION = "1.18.1"
+    VERSION = "1.18.4"
   end
 end

data/lib/github-pages-health-check.rb

@@ -41,7 +41,7 @@ module GitHubPages
     URL = "https://github.com/github/pages-health-check"
     USER_AGENT = "Mozilla/5.0 (compatible; #{HUMAN_NAME}/#{VERSION}; +#{URL})"
 
-    # surpress warn-level feedback due to unsupported record types
+    # suppress warn-level feedback due to unsupported record types
     def self.without_warnings(&block)
       warn_level = $VERBOSE
       $VERBOSE = nil
@@ -66,6 +66,7 @@ module GitHubPages
 
       @typhoeus_options = {
         :followlocation => true,
+        :redir_protocols => %i[http https], # don't allow non-http protocols on redirections
         :timeout => TIMEOUT,
         :accept_encoding => "gzip",
         :method => :head,

data/script/cibuild-docker

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-: ${RUBY_VERSION:="2.7"}
+: ${RUBY_VERSION:="3.2"}
 docker build -t github-pages-health-check --build-arg RUBY_VERSION=$RUBY_VERSION .
 if [ -n "$DEBUG" ]; then
   # Run a shell.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.18.4
 platform: ruby
 authors:
 - GitHub, Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -42,16 +42,22 @@ dependencies:
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +67,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +77,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +99,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
+- ".github/CODEOWNERS"
 - ".github/dependabot.yml"
+- ".github/workflows/pages-gem.yml"
 - ".github/workflows/push-cibuild.yml"
 - ".gitignore"
 - ".rspec"
@@ -145,7 +153,7 @@ homepage: https://github.com/github/github-pages-health-check
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Checks your GitHub Pages site for commons DNS configuration issues
 test_files: []