Add readme to npm #59
Conversation
WalkthroughThis update modifies three areas: the main README file, the iOS example app's Xcode project configuration, and the Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Lite
📒 Files selected for processing (1)
packages/react-native-device-activity/package.json(2 hunks)
🔇 Additional comments (1)
packages/react-native-device-activity/package.json (1)
3-3:Details
❓ Verification inconclusive
Update CHANGELOG for version bump.
The version has been bumped from
0.4.30to0.4.31. Please ensure the project’s CHANGELOG or release notes are updated to document the changes, so consumers know what’s new in this patch.
🏁 Script executed:
#!/bin/bash # List any changelog files in the react-native-device-activity package echo "Package-level changelog files:" find packages/react-native-device-activity -type f -iname '*changelog*' # List any root-level changelog files echo "Root-level changelog files:" find . -maxdepth 1 -type f -iname '*changelog*' # Search for the new version entry across all changelogs echo "Searching for '0.4.31' in all CHANGELOG files:" grep -R '0.4.31' -n --include '*changelog*' .Length of output: 414
Update CHANGELOG for version bump
I didn’t find any CHANGELOG or release-notes file in packages/react-native-device-activity or at the repo root. Please verify where you document releases and add an entry for v0.4.31 to describe the patch changes so consumers know what’s new.
• Check for or create a CHANGELOG.md (or equivalent) in packages/react-native-device-activity or at the repo root
• Add a “0.4.31” section detailing fixes/enhancements since 0.4.30
| "typecheck": "tsc --noEmit", | ||
| "test": "expo-module test", | ||
| "prepublishOnly": "expo-module prepublishOnly && tsc", | ||
| "prepublishOnly": "expo-module prepublishOnly && tsc && cp ../../README.md ./README.md", |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Make README copy cross-platform.
Using cp ../../README.md ./README.md will break on Windows. For reliable cross-platform behavior, consider a Node‐based approach or a small utility like copyfiles. For example:
"scripts": {
- "prepublishOnly": "expo-module prepublishOnly && tsc && cp ../../README.md ./README.md",
+ "prepublishOnly": "expo-module prepublishOnly && tsc && npm run copy-readme",
+ "copy-readme": "copyfiles -u 2 ../../README.md ./README.md"
}This ensures the README is copied correctly on all OSes.
Committable suggestion skipped: line range outside the PR's diff.
Summary by CodeRabbit