Skip to content

release: prepare v0.2.0-alpha.1 - #29

Merged
flyingrobots merged 3 commits into
mainfrom
release/v0.2.0-alpha.1-prep
Jun 21, 2026
Merged

release: prepare v0.2.0-alpha.1#29
flyingrobots merged 3 commits into
mainfrom
release/v0.2.0-alpha.1-prep

Conversation

@flyingrobots

Copy link
Copy Markdown
Owner

Summary

  • Bumps edict-syntax to 0.2.0-alpha.1.
  • Cuts the changelog for v0.2.0-alpha.1.
  • Adds docs/releases/v0.2.0-alpha.1.md with the Core schema scope and explicit non-goals.
  • Updates release-process docs/test-plan and adds a deterministic xtask release-note boundary regression.
  • Updates the roadmap artifact map for release issue Release v0.2.0-alpha.1 #28.

Verification

  • cargo xtask verify
  • npx markdownlint-cli2 CHANGELOG.md ROADMAP.md docs/README.md docs/releases/v0.2.0-alpha.1.md docs/topics/release-process/README.md docs/topics/release-process/test-plan.md

Closes #28.

@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@flyingrobots, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 49 minutes and 35 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9e831a9d-3208-42c6-b482-5d5594960647

📥 Commits

Reviewing files that changed from the base of the PR and between 5f79f49 and f9deda3.

📒 Files selected for processing (4)
  • CHANGELOG.md
  • docs/releases/v0.2.0-alpha.1.md
  • docs/topics/release-process/test-plan.md
  • xtask/src/main.rs

Walkthrough

Prepares the v0.2.0-alpha.1 prerelease by adding the complete release notes document, bumping the edict-syntax crate version, adding a dated changelog entry, updating the docs README and ROADMAP issue tracking, restructuring the release-process README, and adding an xtask boundary test with corresponding test-plan coverage.

Changes

v0.2.0-alpha.1 Release Preparation

Layer / File(s) Summary
Release notes, version bump, and changelog
crates/edict-syntax/Cargo.toml, CHANGELOG.md, docs/releases/v0.2.0-alpha.1.md
Bumps edict-syntax from 0.1.0-alpha.1 to 0.2.0-alpha.1, adds the dated changelog header, and introduces the full 72-line release notes document covering release type, version policy, included scope, explicit non-goals, required verification steps, and tagging plan.
Docs index and roadmap updates
docs/README.md, ROADMAP.md
Adds a v0.2.0-alpha.1 release-notes link to the docs README alongside the v0.1 entry, and adds issue #28 to the v0.2.0-alpha.1 milestone row in ROADMAP's GitHub Artifact Map.
Release-process README restructure
docs/topics/release-process/README.md
Replaces the single "Current Release" subsection with a "Release Notes" section documenting the docs/releases/${TAG}.md loading convention and enumerating both current release-note files.
Automated boundary test and test-plan coverage
xtask/src/main.rs, docs/topics/release-process/test-plan.md
Adds v0_2_release_notes_state_core_boundary xtask unit test that reads docs/releases/v0.2.0-alpha.1.md and asserts required boundary substrings. Extends the test plan with a new fixture entry, RELEASE-TP-003 test case tied to RELEASE-REQ-007, and a determinism-obligation clarification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • flyingrobots/edict#26: Directly connected — both PRs modify xtask/src/main.rs to expand release-process test coverage, with the retrieved PR strengthening release workflow and policy tests that this PR's new boundary test extends.

Poem

🏷️ The version bumps up, the notes are inscribed,
Non-goals enumerated, each scope clearly described.
A boundary test watches, contains() stands guard—
No lowering, no digests, no bytes from the yard.
v0.2.0-alpha.1 steps into the light,
Changelog dated, roadmap aligned, all feels right. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Title directly and concisely describes the main purpose: preparing the v0.2.0-alpha.1 release with appropriate specificity.
Description check ✅ Passed Description comprehensively summarizes all changes in the PR and relates directly to the changeset, covering version bumps, changelog, documentation, and testing.
Linked Issues check ✅ Passed All six checklist items from issue #28 are either completed in code changes or verified per PR description; non-goals are documented in v0.2.0-alpha.1.md release notes.
Out of Scope Changes check ✅ Passed All changes are scoped to v0.2.0-alpha.1 release preparation; no extraneous modifications detected across documentation, versioning, testing, or tooling.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/releases/v0.2.0-alpha.1.md`:
- Around line 37-49: The Explicit Non-Goals section contains a repetitive list
where each of the 10 bullet points begins with "No," which triggers language
style warnings and reduces readability. Restructure this section by adding a
prose introduction that establishes the context (such as "The v0.2.0-alpha.1
release explicitly does not include"), then list the excluded items without the
repeated "No" prefix, either as a shorter bullet list or as a comma-separated
prose list that flows naturally from the introduction.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8f4563f9-edbe-4a78-88ca-ab0c3249cd33

📥 Commits

Reviewing files that changed from the base of the PR and between 5c2e6aa and 5f79f49.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (8)
  • CHANGELOG.md
  • ROADMAP.md
  • crates/edict-syntax/Cargo.toml
  • docs/README.md
  • docs/releases/v0.2.0-alpha.1.md
  • docs/topics/release-process/README.md
  • docs/topics/release-process/test-plan.md
  • xtask/src/main.rs
📜 Review details
🧰 Additional context used
📓 Path-based instructions (4)
**

⚙️ CodeRabbit configuration file

**: # AGENTS

Git Rules

NEVER amend git commits. Make a new commit instead.

NEVER use git rebase unless the user explicitly approves a rare exception.
Use regular merge commits.

NEVER force any git operation. If a force operation appears necessary, stop and
explain what happened and what options remain.

NEVER create draft pull requests.

NEVER use a codex prefix in branch names, PR titles, or commit messages.

Think

Think is durable memory for cross-session coordination.

  • Use codex-think --remember --json when starting a new session, changing into
    this repository, or regaining context after a context shift.
  • Use codex-think "..." --json when a cycle closes or a significant event
    should survive across turns.
  • Treat Think as memory, not repo truth. Anchor strong claims back to files,
    commits, commands, issues, or pull requests.
  • Claude memories are read-only. Use claude-think --remember --json only for
    additional context.

Topic Shelves

docs/topics/ contains the living contract graph for landed behavior. Topic
shelves are not proposals, retrospectives, or design archaeology.

Each shelf may contain:

  • README.md: what is true in HEAD.
  • test-plan.md: how those truths are verified, including requirements, cases,
    fixtures, oracles, implemented evidence, planned cases, and known gaps.
  • architecture.md: optional structure or dataflow notes when the machinery
    earns a separate page.
  • rationale.md: optional still-relevant tradeoffs and rejected approaches.

When To Update Topic Shelves

For every nontrivial behavior, contract, workflow, release, schema, validation,
or public-surface change:

  1. Identify the owning topic shelf before editing code.
  2. If no shelf owns durable behavior, create one.
  3. Update test-plan.md before or alongside tests with requirement IDs, case
    IDs, fixtures, and oracles.
  4. Write executable evidence: deterministic tests, fixtures, doctests, or
    contract checks as appropriate.
  5. Upd...

Files:

  • crates/edict-syntax/Cargo.toml
  • ROADMAP.md
  • docs/README.md
  • docs/releases/v0.2.0-alpha.1.md
  • xtask/src/main.rs
  • docs/topics/release-process/test-plan.md
  • CHANGELOG.md
  • docs/topics/release-process/README.md
docs/topics/**

📄 CodeRabbit inference engine (AGENTS.md)

docs/topics/**: Topic shelves must be located in docs/topics/ and contain the living contract graph for landed behavior.
Each topic shelf may contain README.md, test-plan.md, and optionally architecture.md or rationale.md.

Files:

  • docs/topics/release-process/test-plan.md
  • docs/topics/release-process/README.md
docs/topics/*/test-plan.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/topics/*/test-plan.md: test-plan.md may include planned cases and known gaps.
Update test-plan.md before or alongside tests with requirement IDs, case IDs, fixtures, and oracles.
Mark planned cases as implemented only when executable evidence exists.

Files:

  • docs/topics/release-process/test-plan.md
docs/topics/*/README.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/topics/*/README.md: Topic README.md files must not describe intended behavior before it lands.
Update the topic README.md only after behavior exists in the branch.

Files:

  • docs/topics/release-process/README.md
🪛 LanguageTool
docs/releases/v0.2.0-alpha.1.md

[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ublish. - No source-to-Core lowering. - No compiler CLI. - No import resolver or r...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...-to-Core lowering. - No compiler CLI. - No import resolver or resolved type checke...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~43-~43: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rt resolver or resolved type checker. - No canonical Core encoder. - No golden Cor...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~44-~44: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...checker. - No canonical Core encoder. - No golden Core bytes. - No exact Core dige...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Core encoder. - No golden Core bytes. - No exact Core digests. - No full CDDL inst...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~46-~46: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... Core bytes. - No exact Core digests. - No full CDDL instance-validation harness. ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~47-~47: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ull CDDL instance-validation harness. - No target profile conformance fixtures. - ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... target profile conformance fixtures. - No target lowerers. - No bundle/admission ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~49-~49: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...mance fixtures. - No target lowerers. - No bundle/admission tooling. ## Required ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Comment thread docs/releases/v0.2.0-alpha.1.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5f79f49995

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread CHANGELOG.md Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jun 21, 2026
@flyingrobots

Copy link
Copy Markdown
Owner Author

Code Lawyer Activity Summary

@codex confirmation requested on the final release-prep consistency fix.

# Source Severity File Commit Outcome
1 PR review thread P2 CHANGELOG.md f9deda3 Aligned v0.2.0-alpha.1 changelog date with the release notes target date (2026-07-01). Added RELEASE-REQ-008 / RELEASE-TP-004 and deterministic xtask coverage.

Verification on f9deda3:

  • RED observed: cargo test -p xtask v0_2_changelog_date_matches_release_notes_target -- --nocapture failed before the changelog fix.
  • GREEN verified: focused regression passed after the fix.
  • Contract graph verified: cargo test -p xtask contract_graph_is_valid -- --nocapture passed.
  • Full local gate passed: cargo xtask verify.
  • Markdown/style passed: npx markdownlint-cli2 CHANGELOG.md docs/topics/release-process/test-plan.md docs/releases/v0.2.0-alpha.1.md.
  • Whitespace passed: git diff --check.
  • Review thread PRRT_kwDOS96-Us6LHIlL resolved.

No additional self-discovered issues remain in the PR diff.

@flyingrobots
flyingrobots merged commit 029f434 into main Jun 21, 2026
3 checks passed
@chatgpt-codex-connector

Copy link
Copy Markdown

Summary

Testing

  • ⚠️ codex-think --remember --json && pwd && rg --files -g 'AGENTS.md' -g '!target' -g '!node_modules'codex-think is not installed in this environment.
  • find .. -name AGENTS.md -print && git status --short && git rev-parse HEAD && git branch --show-current
  • cat AGENTS.md && sed -n '1,120p' CHANGELOG.md && sed -n '1,140p' docs/releases/v0.2.0-alpha.1.md && sed -n '1,180p' docs/topics/release-process/test-plan.md && rg -n "v0_2_changelog|RELEASE-REQ-008|RELEASE-TP-004|2026-07-01|2026-06-21" xtask/src/main.rs CHANGELOG.md docs/releases/v0.2.0-alpha.1.md docs/topics/release-process/test-plan.md ROADMAP.md
  • sed -n '700,770p' xtask/src/main.rs && cargo test -p xtask v0_2_changelog_date_matches_release_notes_target -- --nocapture && cargo test -p xtask contract_graph_is_valid -- --nocapture && git diff --check
  • cargo xtask verify
  • ⚠️ npx markdownlint-cli2 CHANGELOG.md docs/topics/release-process/test-plan.md docs/releases/v0.2.0-alpha.1.md — blocked by npm registry 403 Forbidden for markdownlint-cli2.
  • git status --short && nl -ba CHANGELOG.md | sed -n '1,24p' && nl -ba docs/releases/v0.2.0-alpha.1.md | sed -n '1,55p' && nl -ba docs/topics/release-process/test-plan.md | sed -n '24,58p' && nl -ba xtask/src/main.rs | sed -n '720,760p'

View task →

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.

Release v0.2.0-alpha.1

1 participant