Skip to content

Commit 7af6abf

Browse files
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent 2354a86 commit 7af6abf

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
ruby:
2626
- 2.6
2727
- 2.7
28-
- 3.0
28+
- "3.0"
2929
- 3.1
3030
- ruby-head
3131
- jruby
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Build & deploy documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
workflow_dispatch:
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
name: Update gh-pages with docs
11+
steps:
12+
- name: Clone repository
13+
uses: actions/checkout@v2
14+
- name: Set up Ruby
15+
uses: ruby/setup-ruby@v1
16+
with:
17+
ruby-version: "3.1"
18+
- name: Install required gem dependencies
19+
run: gem install yard --no-document
20+
- name: Build YARD Ruby Documentation
21+
run: yardoc
22+
- name: Deploy
23+
uses: peaceiris/actions-gh-pages@v3
24+
with:
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
publish_dir: ./doc/yard
27+
publish_branch: gh-pages

json-ld-preloaded.gemspec

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Gem::Specification.new do |gem|
1010
gem.license = 'Unlicense'
1111
gem.summary = "JSON-LD with preloaded contexts for RDF.rb."
1212
gem.description = "A meta-release of the json-ld gem including preloaded vocabularies for the Ruby RDF.rb library suite."
13+
gem.metadata = {
14+
"documentation_uri" => "https://ruby-rdf.github.io/json-ld-preloaded",
15+
"bug_tracker_uri" => "https://github.com/ruby-rdf/json-ld-preloaded/issues",
16+
"homepage_uri" => "https://github.com/ruby-rdf/json-ld-preloaded",
17+
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
18+
"source_code_uri" => "https://github.com/ruby-rdf/json-ld-preloaded",
19+
}
1320

1421
gem.authors = ['Gregg Kellogg']
1522
gem.email = 'public-linked-json@w3.org'

0 commit comments

Comments
 (0)