Skip to content

docs: release 0.2.1 to republish the corrected README - #16

Merged
warpedatom merged 2 commits into
mainfrom
docs/release-0.2.1
Jul 21, 2026
Merged

docs: release 0.2.1 to republish the corrected README#16
warpedatom merged 2 commits into
mainfrom
docs/release-0.2.1

Conversation

@warpedatom

@warpedatom warpedatom commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Publish release 0.2.1 to republish the crate with corrected documentation and updated version metadata.

Build:

  • Bump crate version from 0.2.0 to 0.2.1 in Cargo metadata.

Documentation:

  • Document the 0.2.1 release in CHANGELOG, noting the refreshed README section for the offsetscan yara subcommand.

@sourcery-ai

sourcery-ai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR performs a documentation-only release bump to 0.2.1 so that crates.io republishes the corrected README, updating the changelog and crate version metadata without modifying runtime code.

File-Level Changes

Change Details Files
Add 0.2.1 release notes documenting the README refresh and clarifying that no code changes are included.
  • Insert a new 0.2.1 section with date and Documentation subsection in the changelog.
  • Explain that the README’s yara-scan section was updated to match the shipped offsetscan yara subcommand and CI coverage.
  • Explicitly note that the release is documentation-only with no code changes.
CHANGELOG.md
Bump the crate version from 0.2.0 to 0.2.1 for the documentation republish release.
  • Update the package version field to 0.2.1 in the crate manifest.
  • Ensure metadata (name, edition, authors, description) remains unchanged.
Cargo.toml
Refresh lockfile to reflect the new crate version while keeping dependencies unchanged.
  • Regenerate Cargo.lock so the root package entry matches version 0.2.1.
  • Verify that dependency versions are otherwise unaffected, aligning with the “no code changes” intent.
Cargo.lock

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="CHANGELOG.md" line_range="13" />
<code_context>
+- Refresh the README `yara-scan` section to describe the shipped `offsetscan yara`
+  subcommand accurately (feature-gated, schema-parity with `Invoke-OffsetYaraScan`, and
+  now covered by a CI job). The 0.2.0 crate's rendered README still carried the old
+  "experimental / not built in CI / untested" wording; this republishes it corrected.
+  No code changes.
+
</code_context>
<issue_to_address>
**nitpick (typo):** Consider rephrasing "this republishes it corrected" for clearer grammar.

That wording reads a bit awkward. Consider alternatives like “this republishes it with corrected wording” or “this republishes a corrected version” for smoother, clearer prose.

```suggestion
  "experimental / not built in CI / untested" wording; this republishes it with corrected wording.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread CHANGELOG.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@warpedatom
warpedatom merged commit 9d58438 into main Jul 21, 2026
6 checks passed
@warpedatom
warpedatom deleted the docs/release-0.2.1 branch July 21, 2026 06:40
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