Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.

gkellogg · gkellogg · commit 1f597b59de53 · 2022-01-28T11:48:41.000-08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,7 +22,7 @@ jobs:
         ruby:
           - 2.6
           - 2.7
-          - 3.0
+          - "3.0"
           - 3.1
           - ruby-head
           - jruby
diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml
@@ -0,0 +1,27 @@
+name: Build & deploy documentation
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Update gh-pages with docs
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+      - name: Install required gem dependencies
+        run: gem install yard --no-document
+      - name: Build YARD Ruby Documentation
+        run: yardoc
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/yard
+          publish_branch: gh-pages
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ This results in the following Turtle:
        doap:developer <http://greggkellogg.net/foaf#me>;
        doap:documenter <http://greggkellogg.net/foaf#me>;
        doap:download-page <https://rubygems.org/gems/rdf-tabular>;
-       doap:homepage <http://ruby-rdf.github.com/rdf-tabular>;
+       doap:homepage <https://ruby-rdf.github.io/rdf-tabular>;
        doap:implements <http://www.w3.org/TR/tabular-data-model/>,
          <http://www.w3.org/TR/tabular-metadata/>,
          <http://www.w3.org/TR/csv2rdf/>,
@@ -165,7 +165,7 @@ It can also generate JSON output (not complete JSON-LD, but compatible with it),
                   "@id": "https://rubygems.org/gems/rdf-tabular",
                   "http://usefulinc.com/ns/doap#name": "RDF::Tabular",
                   "@type": "http://usefulinc.com/ns/doap#Project",
-                  "http://usefulinc.com/ns/doap#homepage": "http://ruby-rdf.github.com/rdf-tabular",
+                  "http://usefulinc.com/ns/doap#homepage": "https://ruby-rdf.github.io/rdf-tabular",
                   "http://usefulinc.com/ns/doap#license": "https://unlicense.org/1.0/",
                   "http://usefulinc.com/ns/doap#shortdesc": "Tabular Data RDF Reader and JSON serializer.",
                   "http://usefulinc.com/ns/doap#description": "RDF::Tabular processes tabular data with metadata creating RDF or JSON output.",
diff --git a/etc/doap.csv b/etc/doap.csv
@@ -1,5 +1,5 @@
 name,type,homepage,license,shortdesc,description,created,programming_language,implements,category,download_page,mailing_list,bug_database,blog,developer,maintainer,documenter,maker,dc_title,dc_description,dc_date,dc_creator,isPartOf
-RDF::Tabular,http://usefulinc.com/ns/doap#Project,http://ruby-rdf.github.com/rdf-tabular,https://unlicense.org/1.0/,Tabular Data RDF Reader and JSON serializer.,RDF::Tabular processes tabular data with metadata creating RDF or JSON output.,1/5/2015,Ruby,http://www.w3.org/TR/tabular-data-model/,http://dbpedia.org/resource/Resource_Description_Framework,https://rubygems.org/gems/rdf-tabular,http://lists.w3.org/Archives/Public/public-rdf-ruby/,https://github.com/ruby-rdf/rdf-tabular/issues,http://greggkellogg.net/,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,RDF::Tabular,RDF::Tabular processes tabular data with metadata creating RDF or JSON output.,1/5/2015,http://greggkellogg.net/foaf#me,https://rubygems.org/gems/rdf
+RDF::Tabular,http://usefulinc.com/ns/doap#Project,https://ruby-rdf.github.io/rdf-tabular,https://unlicense.org/1.0/,Tabular Data RDF Reader and JSON serializer.,RDF::Tabular processes tabular data with metadata creating RDF or JSON output.,1/5/2015,Ruby,http://www.w3.org/TR/tabular-data-model/,http://dbpedia.org/resource/Resource_Description_Framework,https://rubygems.org/gems/rdf-tabular,http://lists.w3.org/Archives/Public/public-rdf-ruby/,https://github.com/ruby-rdf/rdf-tabular/issues,http://greggkellogg.net/,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,http://greggkellogg.net/foaf#me,RDF::Tabular,RDF::Tabular processes tabular data with metadata creating RDF or JSON output.,1/5/2015,http://greggkellogg.net/foaf#me,https://rubygems.org/gems/rdf
 ,http://www.w3.org/ns/earl#TestSubject,,,,,,,http://www.w3.org/TR/tabular-metadata/,http://dbpedia.org/resource/Ruby_(programming_language),,,,,,,,,,,,,
 ,http://www.w3.org/ns/earl#Software,,,,,,,http://www.w3.org/TR/csv2rdf/,,,,,,,,,,,,,,
 ,,,,,,,,http://www.w3.org/TR/csv2json/,,,,,,,,,,,,,,
diff --git a/etc/doap.ttl b/etc/doap.ttl
@@ -9,7 +9,7 @@
 
 <> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Tabular" ;
-  doap:homepage      <https://ruby-rdf.github.com/rdf-tabular> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-tabular> ;
   doap:license       <https://unlicense.org/1.0/> ;
   doap:shortdesc     "Tabular Data RDF Reader and JSON serializer for RDF.rb."@en ;
   doap:description   "RDF::Tabular processes tabular data with metadata creating RDF or JSON output for the RDF.rb library suite."@en ;
diff --git a/etc/earl.html b/etc/earl.html
@@ -100,8 +100,8 @@ <h2>
             <dd property='doap:programming-language'>Ruby</dd>
             <dt>Home Page</dt>
             <dd property='doap:homepage'>
-              <a href='http://ruby-rdf.github.com/rdf-tabular'>
-                http://ruby-rdf.github.com/rdf-tabular
+              <a href='https://ruby-rdf.github.io/rdf-tabular'>
+                https://ruby-rdf.github.io/rdf-tabular
               </a>
             </dd>
             <dt>Developer</dt>
diff --git a/etc/earl.jsonld b/etc/earl.jsonld
@@ -152,7 +152,7 @@
         }
       ],
       "doapDesc": "RDF::Tabular processes tabular data with metadata creating RDF or JSON output.",
-      "homepage": "http://ruby-rdf.github.com/rdf-tabular",
+      "homepage": "https://ruby-rdf.github.io/rdf-tabular",
       "language": "Ruby"
     }
   ],
diff --git a/etc/earl.ttl b/etc/earl.ttl
@@ -8,7 +8,7 @@
 
 <https://rubygems.org/gems/rdf-tabular> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Tabular" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-tabular> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-tabular> ;
   doap:license       <https://unlicense.org/1.0/> ;
   doap:shortdesc     "Tabular Data RDF Reader and JSON serializer."@en ;
   doap:description   "RDF::Tabular processes tabular data with metadata creating RDF or JSON output."@en ;
diff --git a/lib/rdf/tabular/reader.rb b/lib/rdf/tabular/reader.rb
@@ -22,7 +22,7 @@ class Reader < RDF::Reader
 
     ##
     # Writer options
-    # @see https://www.rubydoc.info/github/ruby-rdf/rdf/RDF/Writer#options-class_method
+    # @see https://ruby-rdf.github.io/rdf/RDF/Writer#options-class_method
     def self.options
       super + [
         RDF::CLI::Option.new(
diff --git a/rdf-tabular.gemspec b/rdf-tabular.gemspec
@@ -10,6 +10,13 @@ Gem::Specification.new do |gem|
   gem.license               = 'Unlicense'
   gem.summary               = "Tabular Data RDF Reader and JSON serializer."
   gem.description           = "RDF::Tabular processes tabular data with metadata creating RDF or JSON output."
+  gem.metadata           = {
+    "documentation_uri" => "https://ruby-rdf.github.io/rdf-tabular",
+    "bug_tracker_uri"   => "https://github.com/ruby-rdf/rdf-tabular/issues",
+    "homepage_uri"      => "https://github.com/ruby-rdf/rdf-tabular",
+    "mailing_list_uri"  => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
+    "source_code_uri"   => "https://github.com/ruby-rdf/rdf-tabular",
+  }
 
   gem.authors               = ['Gregg Kellogg']
   gem.email                 = 'public-rdf-ruby@w3.org'

-Original file line number
+Diff line change
         ruby:
           - 2.6
           - 2.7
 -          - 3.0
 +          - "3.0"
           - 3.1
           - ruby-head
           - jruby
Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@`
`152`	`152`	`}`
`153`	`153`	`],`
`154`	`154`	`"doapDesc": "RDF::Tabular processes tabular data with metadata creating RDF or JSON output.",`
`155`		`- "homepage": "http://ruby-rdf.github.com/rdf-tabular",`
	`155`	`+ "homepage": "https://ruby-rdf.github.io/rdf-tabular",`
`156`	`156`	`"language": "Ruby"`
`157`	`157`	`}`
`158`	`158`	`],`