Skip to content

Commit

Permalink
Update documentation links to use gh-pages, and add action to publish…
Browse files Browse the repository at this point in the history
… gh-pages from Yard docs.
  • Loading branch information
gkellogg committed Jan 28, 2022
1 parent db2abf7 commit 6e17a81
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
ruby:
- 2.6
- 2.7
- 3.0
- "3.0"
- 3.1
- ruby-head
- jruby
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ puts data.to_json_c14n
```

## Documentation
Full documentation available on [RubyDoc](http://rubydoc.info/gems/json-canonicalization/file/README.md)
Full documentation available on [RubyDoc](https://dryruby.github.io/json-canonicalization/file/README.md)

### Principal Classes
* {JSON::Canonicalization}
Expand Down
6 changes: 6 additions & 0 deletions json-canonicalization.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Gem::Specification.new do |gem|
gem.license = 'Unlicense'
gem.summary = "JSON Canonicalization for Ruby."
gem.description = "JSON::Canonicalization generates canonical JSON output from Ruby objects."
gem.metadata = {
"documentation_uri" => "https://dryruby.github.io/json-canonicalization",
"bug_tracker_uri" => "https://github.com/dryruby/json-canonicalization/issues",
"homepage_uri" => "https://github.com/dryruby/json-canonicalization",
"source_code_uri" => "https://github.com/dryruby/json-canonicalization",
}

gem.authors = ['Gregg Kellogg']

Expand Down

0 comments on commit 6e17a81

Please sign in to comment.