Release prep - #76
Merged
Merged
Conversation
Enable Dependabot to monitor and update GitHub Actions dependencies alongside Go modules. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Change "Song of Songs" to "Song of Solomon" to match the canonical book name used in the codebase. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add documentation for --exclude and --exclude-index options in today random - Add documentation for --show-ref and --show-passage options in today random - Add documentation for today categories command with --pericopes option - Add comprehensive documentation for OpenScripture.Today commands (today ost) - Update copyright year to 2023-2026 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request prepares the repository for release by updating documentation, adding dependency management automation, and fixing a test case. The changes enhance the README with comprehensive usage instructions for the today command-line tool, including newly documented features for random scripture selection, category listing, and OpenScripture.Today integration.
Changes:
- Fixed canonical book name in test from "Song of Songs" to "Song of Solomon"
- Expanded README documentation with detailed usage instructions for
today random,today categories, and OpenScripture.Today commands - Updated copyright year to 2023-2026 and added GitHub Actions to dependabot configuration
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pkg/ref/random_test.go | Corrected book name to match canonical naming convention |
| README.md | Added extensive documentation for command-line features and updated copyright year |
| .github/dependabot.yml | Added GitHub Actions ecosystem for automated dependency updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request primarily updates the documentation for the
todaycommand-line tool, adding new usage instructions and clarifying existing ones. It also introduces a new dependency update schedule for GitHub Actions and makes a minor correction to a test case.Documentation improvements:
README.mdwith detailed instructions for new features in thetoday randomcommand, including options for excluding references, controlling output display, and using index files. Also added a new section describing thetoday categoriescommand and its options. [1] [2]README.md.Dependency management:
.github/dependabot.ymlto enable weekly update checks for GitHub Actions workflows.Test correction:
TestRandomWithoutBookstest from "Song of Songs" to "Song of Solomon" to match the canonical naming used elsewhere.