Skip to content

Prep 0.2.0 release: document snippets, bump version, fix CI runners#32

Merged
saramaebee merged 1 commit into
mainfrom
release-0.2.0-prep
Jun 12, 2026
Merged

Prep 0.2.0 release: document snippets, bump version, fix CI runners#32
saramaebee merged 1 commit into
mainfrom
release-0.2.0-prep

Conversation

@saramaebee

Copy link
Copy Markdown
Collaborator

Summary

Snippet support already merged to main in #30, but the docs, the version number, and a broken CI runner config were never updated. This makes main release-ready for v0.2.0 and unblocks the hanging PR check.

Docs

  • README.md: new Snippets CLI section (list snippets / snippet-paths / snippet-locations --with-lines, get snippet / snippet-match); MCP Available Tools table (snippet on list, the snippet_match tool, note that snippets are list/drill-in only); Snippet locator.
  • CLAUDE.md: ERD (Revision → Snippet → SnippetMatch), architecture tree, the four snippet endpoints, the Snippet model entry with its API quirks (string id, matchPercentage 0–100 vs 0–1, trailing-blank-EOF off-by-one), and Future Work.

Version

0.1.00.2.0 (Cargo.toml + Cargo.lock).

CI runner fix

The Release workflow pinned ubuntu-20.04 (4 jobs) and, via dist plan, windows-2019 — both retired by GitHub. Jobs requesting them queue until the 24h timeout, so the PR plan check sat pending indefinitely (visible on #30 and #31, both ran 24h → cancelled). Fix pins supported images through [workspace.metadata.dist.github-custom-runners] (ubuntu-22.04 / macos-13 / macos-14 / windows-2022) and regenerates release.yml.

Test plan

  • cargo build succeeds.
  • dist generate --check clean (workflow matches config).
  • dist plan assigns only GitHub-hosted runners (no ubuntu-20.04 / windows-2019).
  • Every documented CLI command token verified against the clap variants in src/cli/mod.rs.
  • This PR's own plan check exercises the fix (head-branch workflow), so it should go green instead of hanging.

After merge

Tag v0.2.0 on main to trigger the cargo-dist release (builds binaries + installers, publishes the GitHub Release).

🤖 Generated with Claude Code

Snippets shipped to main in #30 but the docs, version, and a broken CI
config were never updated. This gets main release-ready for v0.2.0.

Docs:
- README: Snippets CLI section (list snippets/snippet-paths/
  snippet-locations, get snippet/snippet-match), MCP tools table
  (snippet on `list`, the `snippet_match` tool, no get/update), and the
  Snippet locator
- CLAUDE.md: ERD, architecture tree, the four snippet endpoints, the
  Snippet model entry with its API quirks, and Future Work

Version: 0.1.0 -> 0.2.0 (Cargo.toml + Cargo.lock)

CI runner fix: dist 0.27 defaults to ubuntu-20.04 and windows-2019,
both retired by GitHub, so every Release-workflow job queued until the
24h timeout and the PR `plan` check sat "pending" indefinitely. Pin
supported images via [workspace.metadata.dist.github-custom-runners]
(ubuntu-22.04 / macos-13 / macos-14 / windows-2022) and regenerate
release.yml. `dist generate --check` is clean; `dist plan` now assigns
only hosted runners.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@saramaebee saramaebee merged commit 9078519 into main Jun 12, 2026
5 checks passed
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR documents snippet matching functionality across the FOSSA API client and updates release infrastructure. The changes add an ER diagram and API endpoint documentation for querying snippets and their matches, introduce CLI and MCP usage guidance for end users, bump the crate version to 0.2.0, configure cargo-dist to use standardized GitHub-hosted runners per platform, and update the release workflow to use Ubuntu 22.04 instead of Ubuntu 20.04 for primary build jobs.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the three main changes: documentation for snippets, version bump to 0.2.0, and CI runner fixes.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, covering all modifications across documentation, version bumps, and CI configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant