Skip to content

Conversation

@hsbt
Copy link
Member

@hsbt hsbt commented Jun 12, 2025

for #75

@hsbt hsbt temporarily deployed to github-pages June 12, 2025 06:53 — with GitHub Pages Inactive
@shugo shugo requested a review from Copilot June 12, 2025 07:07
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new RDoc documentation generation task to the Rakefile and introduces a GitHub Actions workflow to build and deploy the generated documentation to GitHub Pages.

  • Adds an RDoc::Task in the Rakefile with a rescue block for the dependency.
  • Creates a new workflow file (gh-pages.yml) that sets up, builds, and deploys the RDoc site.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
Rakefile Introduces a new RDoc::Task block to generate documentation.
.github/workflows/gh-pages.yml Adds a GitHub Actions workflow for building and deploying docs.
Comments suppressed due to low confidence (1)

.github/workflows/gh-pages.yml:5

  • Verify that the branch filter ('master') aligns with the repository's default branch to ensure that deployments trigger as intended.
branches: [ 'master' ]

doc.rdoc_files = FileList.new %w[ext lib README.md BSDL COPYING]
doc.rdoc_dir = "_site" # for github pages
end
rescue LoadError
Copy link

Copilot AI Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider logging a warning in the rescue block to indicate that documentation generation is skipped due to a missing dependency, instead of failing silently.

Suggested change
rescue LoadError
rescue LoadError
warn "Warning: 'rdoc/task' is not available. Skipping documentation generation."

Copilot uses AI. Check for mistakes.
@shugo shugo merged commit 0801aea into master Jun 12, 2025
9 checks passed
@shugo shugo deleted the gh-pages branch June 12, 2025 07:08
@shugo
Copy link
Member

shugo commented Jun 12, 2025

@hsbt I've merged it. Thank you!

@hsbt
Copy link
Member Author

hsbt commented Jun 12, 2025

👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants