jekyll-theme-open-project-helpers 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f94594d15f1b9e8b4c7a02d99a6ebfed8164ad00e65fedffb9fd5f3deed0bde
-  data.tar.gz: e45b408956ce95fd59e813b1f1af8ec284d0c52938abe12fde4d90ee5d8be24b
+  metadata.gz: d2af15e9882d15732f6c20715f4823b9979f59c60febeae4edc26004db20fb2f
+  data.tar.gz: 41480819941abc2f376fddd95571b6473258f547338424b1b0a0f39894a4ebeb
 SHA512:
-  metadata.gz: 5b0b8be8ff9299477f8d3ceb29c02832a4e3b61af1f98db082245862c18da9c3ea7441e41a8e4a0097fab6edc6c48524abe1d823a3a799001d809d6e1a1c4afa
-  data.tar.gz: adc2f75f13ed2548901e9b8c008b7385f43a07a42a57c94e639d6e54a78e2032cd25a2f780463711593dd72a93e854237514b17f31906cc30e237ec2ef7373ac
+  metadata.gz: a46054eeb605e0aa6edf7d15a6d267bd3fe760d6134c2766466da109c939023229df0d77ada8e4078771fa920449400ac5b062a1102d11d131b11ffe2d7b3f96
+  data.tar.gz: 8e85bcc789cabdbb79f62d9eb5d5d8b08bf3ae45e92f43ca003ddeb7ecaa6c55cba407d816d47948ee5227bf9e130f064bc96526f853cc0884b4cc84c39871f9

data/jekyll-theme-open-project-helpers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'jekyll-theme-open-project-helpers'
-  s.version       = '2.1.5'
+  s.version       = '2.1.6'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 

data/lib/jekyll-theme-open-project-helpers/project_data_reader.rb

@@ -6,7 +6,9 @@ module Jekyll
     DEFAULT_DOCS_SUBTREE = 'docs'
 
     DEFAULT_REPO_REMOTE_NAME = 'origin'
-    DEFAULT_REPO_BRANCH = 'master'
+    DEFAULT_REPO_BRANCH = 'main'
+    # Can be overridden by default_repo_branch in site config.
+    # Used by shallow_git_checkout.
 
     class NonLiquidDocument < Jekyll::Document
       def render_with_liquid?
@@ -95,7 +97,8 @@ module Jekyll
           git_shallow_checkout(
             File.join(@site.source, 'parent-hub'),
             @site.config['parent_hub']['git_repo_url'],
-            ['assets', 'title.html'])
+            ['assets', 'title.html'],
+            @site.config['parent_hub']['git_repo_branch'])
         end
       end
 
@@ -110,7 +113,8 @@ module Jekyll
           git_shallow_checkout(
             project_path,
             project['site']['git_repo_url'],
-            ['assets', '_posts', '_software', '_specs'])
+            ['assets', '_posts', '_software', '_specs'],
+            project['site']['git_repo_branch'])
 
           
           Jekyll.logger.debug("OPF:", "Reading files in project #{project_path}")
@@ -131,6 +135,7 @@ module Jekyll
         src = index_doc.data['spec_source']
         repo_url = src['git_repo_url']
         repo_subtree = src['git_repo_subtree']
+        repo_branch = src['git_repo_branch']
         build = src['build']
         engine = build['engine']
         engine_opts = build['options'] || {}
@@ -142,7 +147,7 @@ module Jekyll
                       spec_checkout_path
                     end
 
-        repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree])
+        repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree], repo_branch)
 
         if repo_checkout[:success]
           if build_pages
@@ -215,13 +220,15 @@ module Jekyll
 
           docs = index_doc.data['docs']
           main_repo = index_doc.data['repo_url']
+          main_repo_branch = index_doc.data['repo_branch']
 
           sw_docs_repo = (if docs then docs['git_repo_url'] end) || main_repo
           sw_docs_subtree = (if docs then docs['git_repo_subtree'] end) || DEFAULT_DOCS_SUBTREE
+          sw_docs_branch = (if docs then docs['git_repo_branch'] end) || nil
 
           docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
 
-          sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree])
+          sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree], sw_docs_branch)
 
           if sw_docs_checkout[:success]
             CollectionDocReader.new(site).read(
@@ -234,7 +241,7 @@ module Jekyll
           # unless it’s the same as the repo where docs are.
           if !sw_docs_checkout[:success] or sw_docs_repo != main_repo
             repo_path = "#{index_doc.path.split('/')[0..-2].join('/')}/_#{item_name}_repo"
-            repo_checkout = git_shallow_checkout(repo_path, main_repo)
+            repo_checkout = git_shallow_checkout(repo_path, main_repo, [], main_repo_branch)
             index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
           else
             index_doc.merge_data!({ 'last_update' => sw_docs_checkout[:modified_at] })
@@ -242,7 +249,7 @@ module Jekyll
         end
       end
 
-      def git_shallow_checkout(repo_path, remote_url, sparse_subtrees=[])
+      def git_shallow_checkout(repo_path, remote_url, sparse_subtrees, branch_name)
         # Returns hash with timestamp of latest repo commit
         # and boolean signifying whether new repo has been initialized
         # in the process of pulling the data.
@@ -279,6 +286,7 @@ module Jekyll
         end
 
         refresh_condition = @@siteconfig['refresh_remote_data'] || 'last-resort'
+        repo_branch = branch_name || @@siteconfig['default_repo_branch'] || DEFAULT_REPO_BRANCH
 
         unless ['always', 'last-resort', 'skip'].include?(refresh_condition)
           raise RuntimeError.new('Invalid refresh_remote_data value in site’s _config.yml!')
@@ -287,14 +295,14 @@ module Jekyll
         if refresh_condition == 'always'
           repo.fetch(DEFAULT_REPO_REMOTE_NAME, { :depth => 1 })
           repo.reset_hard
-          repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+          repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
 
         elsif refresh_condition == 'last-resort'
           # This is the default case.
 
           begin
             # Let’s try in case this repo has been fetched before (this would never be the case on CI though)
-            repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+            repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
           rescue Exception => e
             if is_sparse_checkout_error(e, sparse_subtrees)
               # Silence errors caused by nonexistent sparse checkout directories
@@ -309,7 +317,7 @@ module Jekyll
               repo.fetch(DEFAULT_REPO_REMOTE_NAME, { :depth => 1 })
               begin
                 # Try checkout again
-                repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+                repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
               rescue Exception => e
                 if is_sparse_checkout_error(e, sparse_subtrees)
                   # Again, silence an error caused by nonexistent sparse checkout directories…

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-27 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme