Skip to content
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

Merged
merged 2 commits into from
Feb 25, 2024
Merged

ci: build project before publish to NPM #57

merged 2 commits into from
Feb 25, 2024

Conversation

mheob
Copy link
Owner

@mheob mheob commented Feb 25, 2024

📚 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

  • Chores
    • Improved the release process by adding a build step before releasing the binary.

@mheob mheob added bug Something isn't working ci/cd Related to Continuous Integration or Continuous Delivery labels Feb 25, 2024
Copy link

coderabbitai bot commented Feb 25, 2024

Walkthrough

This update introduces a crucial step in the project's release pipeline to ensure that the build artifacts, specifically the dist folder, are generated before the project is packaged and released. This change aims to rectify an issue where the published version on NPM lacked the necessary build artifacts, rendering the package unusable.

Changes

File(s) Change Summary
.github/workflows/release.yml Added a step to build the project before releasing

Assessment against linked issues

Objective Addressed Explanation
[#56]: Missing build artifacts/dist folder in NPM release

Poem

In the realm of code, where rabbits hop,
A tiny fix, makes errors stop.
With builds anew, the dist takes flight,
A package fixed, in the moonlight's sight.
🌙🐰📦
Cheers to paths, now rightly traced,
In the world of code, no effort's wasted.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

sonarcloud bot commented Feb 25, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@kodiakhq kodiakhq bot merged commit 2d2e4a1 into main Feb 25, 2024
6 checks passed
@kodiakhq kodiakhq bot deleted the 56-bug-no-dist branch February 25, 2024 05:51
Copy link

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between fba19e8 and 627ffe8.
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 the pnpm build command is correctly configured in the project's package.json to generate the expected artifacts, particularly the dist 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

Copy link

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.

Suggested change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci/cd Related to Continuous Integration or Continuous Delivery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: Release v1.1.0 on NPM is missing build artifacts/dist folder.
1 participant