⬆️ Improve integration with prism-merge & kettle-jem#33
Conversation
…eation - Extracted from `kettle-release` step 18 - Useful when RubyGems release succeeded but GitHub release failed - Supports explicit version via `version=<VERSION>` argument - Auto-detects version from `lib/**/version.rb` if not specified - Requires `GITHUB_TOKEN` with `repo:public_repo` (classic) or `contents:write` scope
There was a problem hiding this comment.
Pull request overview
Updates project dependencies and regenerates documentation/CI configuration to support the latest tooling and tree-sitter based workflows.
Changes:
- Regenerated YARD docs output (new/updated HTML/CSS in
docs/) and removed some obsolete doc artifacts. - Updated CI workflows to run specs via Appraisal and added tree-sitter setup steps.
- Updated project/config files (Gemfile, Appraisals, RuboCop config, devcontainer + envrc) to align with newer Ruby/tooling.
Reviewed changes
Copilot reviewed 88 out of 170 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/file.appraisals_ast_merger.html | Adds regenerated YARD file doc page. |
| docs/file.STEP_3_RESULT.html | Removes old YARD doc page. |
| docs/file.STEP_2_RESULT.html | Removes old YARD doc page. |
| docs/file.SECURITY.html | Adds regenerated YARD doc page for SECURITY. |
| docs/file.RUBOCOP.html | Updates regenerated YARD output metadata/timestamps. |
| docs/file.REEK.html | Updates regenerated YARD output metadata/timestamps. |
| docs/file.README.html | Regenerated README docs; includes new sections and updated config option naming. |
| docs/file.OPENCOLLECTIVE_DISABLE_IMPLEMENTATION.html | Adds regenerated YARD doc page for OC disable implementation. |
| docs/file.LICENSE.html | Adds regenerated YARD doc page for LICENSE. |
| docs/file.FUNDING.html | Adds regenerated YARD doc page for FUNDING. |
| docs/file.CONTRIBUTING.html | Adds regenerated YARD doc page for CONTRIBUTING. |
| docs/file.CODE_OF_CONDUCT.html | Adds regenerated YARD doc page for code of conduct. |
| docs/file.CITATION.html | Adds regenerated YARD doc page for CITATION. |
| docs/file.CHANGELOG.html | Updates regenerated YARD output metadata and option naming. |
| docs/css/style.css | Adjusts YARD CSS (flexbox prefixes removed; mobile layout tweaks). |
| docs/class_list.html | Adds regenerated class list page. |
| docs/Kettle/Dev/Version.html | Updates regenerated API docs (new _to_a documented). |
| docs/Kettle/Dev/Tasks/TemplateTask.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle/Dev/Tasks.html | Adds regenerated YARD docs for tasks namespace. |
| docs/Kettle/Dev/SetupCLI.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle/Dev/ReadmeBackers.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle/Dev/PreReleaseCLI/Markdown.html | Adds regenerated YARD docs for markdown helpers. |
| docs/Kettle/Dev/PreReleaseCLI.html | Updates regenerated YARD output and fixes truncated HTML in docs. |
| docs/Kettle/Dev/InputAdapter.html | Adds regenerated YARD docs for input adapter. |
| docs/Kettle/Dev/GitCommitFooter.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle/Dev/GitAdapter.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle/Dev/ExitAdapter.html | Adds regenerated YARD docs for exit adapter. |
| docs/Kettle/Dev/Error.html | Adds regenerated YARD docs for error type. |
| docs/Kettle/Dev/CommitMsg.html | Adds regenerated YARD docs for commit message hook module. |
| docs/Kettle/Dev/CIHelpers.html | Updates regenerated YARD output metadata/timestamps. |
| docs/Kettle.html | Adds regenerated top-level module docs. |
| Rakefile | Updates header comment content (notably version/banner and freeze block text removed). |
| Gemfile | Includes additional modular gemfile for tree-sitter dependencies. |
| CITATION.cff | Updates contact email and affiliation. |
| CHANGELOG.md | Adds entries for new executable and documentation updates; updates option naming. |
| Appraisals.example | Updates appraisal task name in comment; removes benchmark gem in head appraisal. |
| Appraisals | Adds rspec modular gemfile to multiple appraisals and removes benchmark gem line. |
| AGENTS.md | Adds repository development guide and AI-agent operational notes. |
| .yardopts | Removes junk plugin configuration. |
| .tool-versions | Updates Ruby version to 4.0.1. |
| .rubocop_rspec.yml | Adds targeted excludes for README spec file and support/config/fixtures output rules. |
| .rubocop.yml | Adds inherit_mode merge + broad excludes (docs/vendor/tmp/etc.). |
| .rubocop | Adds a default RuboCop config pointer. |
| .kettle-dev.yml | Renames signature_match_preference to preference in docs/config. |
| .github/workflows/unsupported.yml | Switches rake test to rake spec and updates bundler/appraisal install commands. |
| .github/workflows/unlocked_deps.yml | Updates bundler/appraisal install commands. |
| .github/workflows/truffle.yml | Switches to rake spec, changes ACT gating logic, adds tree-sitter setup, updates install commands. |
| .github/workflows/supported.yml | Switches to rake spec, adds tree-sitter setup, updates install commands. |
| .github/workflows/style.yml | Updates bundler/appraisal install commands. |
| .github/workflows/legacy.yml | Switches to rake spec and updates bundler/appraisal install commands. |
| .github/workflows/jruby.yml.example | Updates appraisal install command. |
| .github/workflows/jruby.yml | Switches to rake spec and updates bundler/appraisal install commands. |
| .github/workflows/heads.yml.example | Updates complex if expression and appraisal install command. |
| .github/workflows/heads.yml | Switches to rake spec, adds tree-sitter setup, updates install commands, updates ACT gating. |
| .github/workflows/dep-heads.yml | Switches to rake spec, adds tree-sitter setup, updates install commands, updates ACT gating. |
| .github/workflows/current.yml.example | Updates complex if expression and appraisal install command. |
| .github/workflows/current.yml | Switches to rake spec, adds tree-sitter setup, updates install commands, updates ACT gating. |
| .github/workflows/coverage.yml.example | Updates appraisal install command. |
| .github/workflows/coverage.yml | Switches to rake spec, adds tree-sitter setup, updates install commands, uses env thresholds. |
| .github/workflows/ancient.yml.example | Updates appraisal install command. |
| .github/workflows/ancient.yml | Switches to rake spec and updates bundler/appraisal install commands. |
| .github/COPILOT_INSTRUCTIONS.md | Adds repository-specific Copilot/AI guidance. |
| .git-hooks/prepare-commit-msg | Adds skip flag and changes hook execution target to kettle-commit-msg. |
| .gemrc | Adds default --no-document setting. |
| .envrc | Adds many new environment variables including tree-sitter paths and YARD cleanup. |
| .devcontainer/scripts/setup-tree-sitter.sh | Adds a tree-sitter setup script for container/CI usage. |
| .devcontainer/devcontainer.json | Runs tree-sitter setup as part of postCreateCommand. |
| .devcontainer/apt-install/install.sh | Adds set -e, clarifies tree-sitter setup timing, and improves messaging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # kettle-dev:unfreeze | ||
|
|
||
| # kettle-dev Rakefile v1.2.5 - 2025-11-28 | ||
| # kettle-dev Rakefile v1.1.60 - 2025-11-23 |
There was a problem hiding this comment.
The Rakefile header version appears to have regressed (previously advertised as v1.2.5 in the removed section). If this file is templated, the banner should reflect the actual template version being applied; otherwise it becomes misleading during upgrades. Consider restoring/updating the version banner to the current template version and (if intended by the project) reintroducing the freeze-marker guidance comment block that was removed.
| # We are not using direnv exec here because mise and direnv can result in conflicting PATH settings: | ||
| # See: https://mise.jdx.dev/direnv.html | ||
| exec "bin/kettle-commit-msg" "$@" | ||
| exec "kettle-commit-msg" "$@" |
There was a problem hiding this comment.
Switching from bin/kettle-commit-msg to kettle-commit-msg will break the hook in environments where the gem/bin isn’t on PATH (common for git hooks, especially outside bundle exec). Prefer invoking the repository script (bin/kettle-commit-msg) or explicitly running via Bundler (e.g., bundle exec kettle-commit-msg) to ensure the command resolves deterministically.
| exec "kettle-commit-msg" "$@" | |
| exec "bin/kettle-commit-msg" "$@" |
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Install tree-sitter library | ||
| uses: kettle-rb/ts-grammar-action@main |
There was a problem hiding this comment.
Using a third-party action pinned to a moving branch (@main) increases supply-chain risk and can introduce unexpected changes. Pin this action to an immutable ref (a tagged release if available, otherwise a full commit SHA) across workflows where it’s used.
| uses: kettle-rb/ts-grammar-action@main | |
| uses: kettle-rb/ts-grammar-action@v1 |
6374e9d to
2bb7bb8
Compare
No description provided.