-
-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: build project before publish to NPM #57
Conversation
WalkthroughThis update introduces a crucial step in the project's release pipeline to ensure that the build artifacts, specifically the Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to path filters (2)
package.json
is excluded by:!**/*.json
pnpm-lock.yaml
is excluded by:!**/*.yaml
Files selected for processing (1)
- .github/workflows/release.yml (1 hunks)
Additional comments: 1
.github/workflows/release.yml (1)
- 34-35: The addition of the build step using
pnpm build
is correctly placed before the release step, ensuring that the project is built and all necessary artifacts are generated before publishing to NPM. This change addresses the issue of missing build artifacts in the published package. However, it's important to ensure that thepnpm build
command is correctly configured in the project'spackage.json
to generate the expected artifacts, particularly thedist
folder mentioned in the PR objectives.
@@ -31,6 +31,9 @@ jobs: | |||
- name: Install Dependencies | |||
run: pnpm install --frozen-lockfile | |||
|
|||
- name: Build the project | |||
run: pnpm build | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Release binary
step uses npm publish
to publish the package. Given that the workflow uses PNPM for dependency management and build processes, consider using pnpm publish
instead of npm publish
for consistency and to leverage any PNPM-specific features or optimizations during the publication process. This change could potentially enhance the reliability and efficiency of the release workflow.
- run: npm publish
+ run: pnpm publish
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
📚 Summary
Add build step before publishing to NPM in the GitHub workflow.
📋 Side Changes
Also update all minor dependencies.
📌 Related Issues
Resolves #56
Summary by CodeRabbit