Skip to content

test: protect experimental package status contract - #162

Merged
mohanagy merged 1 commit into
developmentfrom
fix-161-experimental-status
Jul 21, 2026
Merged

test: protect experimental package status contract#162
mohanagy merged 1 commit into
developmentfrom
fix-161-experimental-status

Conversation

@mohanagy

@mohanagy mohanagy commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Closes #161

Why

The release-artifact test claimed to retain Miftah's experimental package status but did not assert the canonical changelog wording.

Change

Adds one focused CHANGELOG.md assertion to the existing release-version contract. Production documentation and release behavior are unchanged.

Validation

  • npx vitest run tests/release-version.test.ts --reporter=dot
  • npm run lint
  • npm run typecheck

TDD evidence: without the new assertion, the focused suite passed after a controlled removal of Miftah is experimental and pre-1.0; with the assertion it failed as expected; restoring the existing canonical text makes it pass.

Summary by CodeRabbit

  • Tests
    • Added coverage ensuring the changelog identifies the package as experimental and pre-1.0.
    • Existing checks for release notes and README content remain covered.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b13310a8-d9f4-4f82-9f30-b918e8a1a424

📥 Commits

Reviewing files that changed from the base of the PR and between 0bb20f8 and 1fbee86.

📒 Files selected for processing (1)
  • tests/release-version.test.ts

📝 Walkthrough

Walkthrough

The release-version test now checks that CHANGELOG.md retains the “Miftah is experimental and pre-1.0” wording alongside existing release-note and README assertions.

Changes

Release changelog contract

Layer / File(s) Summary
Changelog status assertion
tests/release-version.test.ts
Adds an assertion that the raw changelog contains the canonical experimental and pre-1.0 package status text.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • mohanagy/miftah#42: Introduced the release policy and changelog wording covered by this assertion.
  • mohanagy/miftah#45: Added related release-version assertions for experimental package status.
  • mohanagy/miftah#133: Updated overlapping security and containment changelog assertions.

Poem

A rabbit checks the changelog line,
“Experimental” still shines.
Pre-1.0, safely penned,
The release contract now won’t bend.
Hop, hop—tests defend!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the focused test change.
Description check ✅ Passed It covers the rationale, focused change, and validation, with only minor template-section omissions.
Linked Issues check ✅ Passed The added exact changelog assertion matches issue #161's acceptance criteria and preserves behavior.
Out of Scope Changes check ✅ Passed The change is a single test assertion and introduces no unrelated code or behavior changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-161-experimental-status

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


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

@mohanagy

Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.


You're currently rate limited under our Fair Usage Limits Policy. Your recent PR review activity is in the 95th percentile or higher among CodeRabbit users, so adaptive limits apply. Your next review will be available in 10 seconds.

@mohanagy

Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@mohanagy
mohanagy merged commit 3b8a682 into development Jul 21, 2026
12 checks passed
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.

test: protect experimental package status in release changelog contract

1 participant