Skip to content

fix: copy README to package dir before npm publish#31

Merged
rsbh merged 1 commit intomainfrom
fix_add_readme_npm
Apr 9, 2026
Merged

fix: copy README to package dir before npm publish#31
rsbh merged 1 commit intomainfrom
fix_add_readme_npm

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented Apr 9, 2026

Summary

Test plan

  • Verified with act release --dryrun — workflow parses and runs correctly

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

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: 04c1716c-2c4a-4295-b05b-f99af7ad08c5

📥 Commits

Reviewing files that changed from the base of the PR and between 6896b08 and 6b9b391.

📒 Files selected for processing (1)
  • .github/workflows/release.yml

📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Updated release workflow to ensure the README file is included in the published package distribution.

Walkthrough

A new step called "Copy README" was added to the npm-release job in the release workflow. This step copies the top-level README.md file into the package directory before the publish command executes.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
.github/workflows/release.yml
Added a "Copy README" step to the npm-release job to copy the repository's README.md into the package working directory before publishing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • chore: add release workflow #15 — Both PRs modify .github/workflows/release.yml and the npm-release job; this PR adds a step that depends on the job structure introduced in the related PR.

Suggested reviewers

  • rohilsurana
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a step to copy README before npm publish in the release workflow.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose (fixing missing README on npm) and the test plan used.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix_add_readme_npm

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.

@rsbh rsbh merged commit 50401fc into main Apr 9, 2026
1 check 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.

2 participants