Skip to content

fix: publish Claude settings with core package - #672

Merged
rafaelscosta merged 2 commits into
mainfrom
fix/publish-claude-settings-contract-20260507
May 7, 2026
Merged

fix: publish Claude settings with core package#672
rafaelscosta merged 2 commits into
mainfrom
fix/publish-claude-settings-contract-20260507

Conversation

@rafaelscosta

@rafaelscosta rafaelscosta commented May 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • include .claude/settings.json in the npm package files contract
  • require .claude/settings.json in package completeness validation
  • bump core to 5.1.12 and add STORY-123.17 release evidence

Validation

  • git diff --check
  • node scripts/validate-package-completeness.js (32/32)
  • npm pack --dry-run --json includes .claude/settings.json
  • npm run validate:publish
  • npm run validate:semantic-lint
  • npm run validate:manifest
  • npm run lint -- --quiet
  • npm run typecheck
  • npm run test:ci (315 suites / 7,847 tests)

Context

Follow-up to #671: 5.1.11 published the version bump and CLI, but the package tarball did not include .claude/settings.json, so the shell-neutral hook settings were only available in the repo checkout. This closes the package contract.

Summary by CodeRabbit

  • New Features

    • Claude settings are now included with the published npm package.
  • Chores

    • Package version bumped to 5.1.12.
    • Package publish validation strengthened to ensure required artifacts are present and to perform smoke validation of the installed package.

@vercel

vercel Bot commented May 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
aiox-core Ready Ready Preview, Comment May 7, 2026 4:25pm

Request Review

@github-actions github-actions Bot added area: agents Agent system related area: workflows Workflow system related squad mcp type: test Test coverage and quality area: core Core framework (.aios-core/core/) area: installer Installer and setup (packages/installer/) area: synapse SYNAPSE context engine area: cli CLI tools (bin/, packages/aios-pro-cli/) area: pro Pro features (pro/) area: health-check Health check system area: docs Documentation (docs/) area: devops CI/CD, GitHub Actions (.github/) labels May 7, 2026
@coderabbitai

coderabbitai Bot commented May 7, 2026

Copy link
Copy Markdown

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e6b32e9c-fd10-46d0-8de1-ba730fc5b2e9

📥 Commits

Reviewing files that changed from the base of the PR and between 220ed43 and 3cc16bc.

📒 Files selected for processing (1)
  • scripts/validate-package-completeness.js
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/validate-package-completeness.js

Walkthrough

This PR ensures .claude/settings.json is published within the npm package by updating the package manifest's files array, bumping the package version to 5.1.12, and adding corresponding validation rules to the package completeness script.

Changes

Claude Settings Package Inclusion

Layer / File(s) Summary
Release Contract & Requirements
docs/stories/epic-123/STORY-123.17-publish-claude-settings-contract.md
Story contract defines the goal of publishing .claude/settings.json and lists acceptance criteria covering package.json.files, tarball validation via scripts/validate-package-completeness.js, npm pack --dry-run inclusion, and smoke validation commands.
Package Manifest & Version
package.json
Version bumped from 5.1.11 to 5.1.12; .claude/settings.json added to the files array to include it in published package contents.
Completeness Validation Rules
scripts/validate-package-completeness.js
REQUIRED_PATHS and REQUIRED_FILES_ENTRIES both updated to include .claude/settings.json, ensuring tarball completeness validation requires the file presence and package.json files array membership.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • SynkraAI/aiox-core#671: Both PRs work with .claude/settings.json—the related PR modifies its contents for shell-neutrality; this PR ensures it is included in the published package.
  • SynkraAI/aiox-core#670: Both PRs modify scripts/validate-package-completeness.js to add specific required package files to validation lists.

Suggested reviewers

  • oalanicolas
  • Pedrovaleriolopez
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly describes the main change: adding Claude settings to the npm package publication.
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.

✨ 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/publish-claude-settings-contract-20260507

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.

@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

📊 Coverage Report

Coverage report not available

📈 Full coverage report available in Codecov


Generated by PR Automation (Story 6.1)

@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 `@scripts/validate-package-completeness.js`:
- Around line 67-70: The current validation uses startsWith for every
REQUIRED_FILES_ENTRIES item (including concrete files like
'.claude/settings.json'), allowing false positives such as
'.claude/settings.json.bak'; update the validation logic that iterates
REQUIRED_FILES_ENTRIES so that entries ending with '/' are treated as directory
prefixes (use startsWith) while entries not ending with '/' are matched with
exact equality (use ===) against file paths; locate the check around the
startWith usage (referencing REQUIRED_FILES_ENTRIES and the validation
function/block that performs the startsWith check on line ~217) and implement
the dual-branch matching (prefix for directories, exact for files).
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 627bc975-d632-4763-a011-c44769ff8ce8

📥 Commits

Reviewing files that changed from the base of the PR and between a892ff1 and 220ed43.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • docs/stories/epic-123/STORY-123.17-publish-claude-settings-contract.md
  • package.json
  • scripts/validate-package-completeness.js

Comment thread scripts/validate-package-completeness.js
@rafaelscosta
rafaelscosta merged commit 72134f7 into main May 7, 2026
40 checks passed
@rafaelscosta
rafaelscosta deleted the fix/publish-claude-settings-contract-20260507 branch May 7, 2026 16:28
tuanmedeiros pushed a commit to tuanmedeiros/aios-core-synkraay that referenced this pull request Jun 2, 2026
* fix: publish Claude settings with core package

* fix: require exact package file entries
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: agents Agent system related area: cli CLI tools (bin/, packages/aios-pro-cli/) area: core Core framework (.aios-core/core/) area: devops CI/CD, GitHub Actions (.github/) area: docs Documentation (docs/) area: health-check Health check system area: installer Installer and setup (packages/installer/) area: pro Pro features (pro/) area: synapse SYNAPSE context engine area: workflows Workflow system related mcp squad type: test Test coverage and quality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant