Skip to content

Commit 1328563

Browse files
authored
Merge pull request #6 from sue445/yard
Add yard
2 parents 225161f + a8e1504 commit 1328563

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

.github/workflows/pages.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy static content to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches:
8+
- main
9+
10+
# Allows you to run this workflow manually from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow one concurrent deployment
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: true
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
35+
- uses: ruby/setup-ruby@v1
36+
with:
37+
ruby-version: ruby
38+
bundler-cache: true
39+
40+
- run: bundle exec yard
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v5
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
# Upload entire repository
48+
path: './doc'
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@main
52+
53+
- name: Slack Notification (not success)
54+
uses: act10ns/slack@v2
55+
if: "! success()"
56+
continue-on-error: true
57+
with:
58+
status: ${{ job.status }}
59+
webhook-url: ${{ secrets.SLACK_WEBHOOK }}

.yardopts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
--markup markdown
2+
--no-private
3+
--hide-void-return
4+
-
5+
CHANGELOG.md
6+
LICENSE.txt

ruby_header_parser.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
4343
spec.add_development_dependency "rspec-temp_dir"
4444
spec.add_development_dependency "rubocop"
4545
spec.add_development_dependency "rubocop_auto_corrector"
46+
spec.add_development_dependency "yard"
4647

4748
# For more information and examples about making a new gem, check out our
4849
# guide at: https://bundler.io/guides/creating_gem.html

0 commit comments

Comments
 (0)