Conversation
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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." |
Member
|
@hsbt I've merged it. Thank you! |
Member
Author
|
👌 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
for #75