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

Add CI workflow for npm package publishing #144

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Add CI workflow for npm package publishing #144

merged 2 commits into from
Jul 26, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Jul 26, 2024

What this PR does / why we need it:

Add CI workflow for npm package publishing

Special notes for your reviewer:

Which issue(s) this PR fixes:

Fixes #

Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Introduced an automated workflow for publishing Node.js packages to the npm registry upon release creation.
  • Changes

    • Updated component and style imports across various application files to streamline references to the newly organized @yorkie-ui/core package.
    • Modified build and dependency management scripts to reflect the transition to @yorkie-ui/core, improving maintainability.

Copy link

coderabbitai bot commented Jul 26, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes introduce a new GitHub Actions workflow for automating the publishing of Node.js packages to npm upon release creation. Additionally, the project has undergone a transition from @yorkie-ui/components to @yorkie-ui/core, updating import statements and dependencies across multiple files. This restructuring simplifies the component library and streamlines the build process, enhancing maintainability and functionality.

Changes

File(s) Change Summary
.github/workflows/npm-publish.yml New workflow for automating npm package publishing on release creation.
apps/storybook/.storybook/preview.ts Updated stylesheet import from @yorkie-ui/components to @yorkie-ui/core.
apps/storybook/package.json Changed prebuild script and dependency from @yorkie-ui/components to @yorkie-ui/core.
apps/storybook/src/stories/button/*.tsx Modified Button component import from @yorkie-ui/components to @yorkie-ui/core.
apps/web/package.json Updated prebuild script and dependency from @yorkie-ui/components to @yorkie-ui/core.
apps/web/src/app/layout.tsx Changed styles import from @yorkie-ui/components to @yorkie-ui/core.
apps/web/src/app/page.tsx Updated Button component import from @yorkie-ui/components to @yorkie-ui/core.
packages/core/package.json Renamed package from @yorkie-ui/components to @yorkie-ui/core.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant npm
    
    User->>GitHub: Create a release
    GitHub->>npm: Trigger npm publish workflow
    npm->>GitHub: Install dependencies
    GitHub->>npm: Run build process
    GitHub->>npm: Publish package
    npm-->>User: Package published successfully
Loading

Poem

🐇 In the garden where changes bloom,
Components shift to give more room.
From components to core they leap,
Simplifying paths, in joy we keep.
With each release, a hop and cheer,
A brighter future, oh so near! 🌼


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 testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@hackerwins hackerwins merged commit f1c797c into main Jul 26, 2024
2 checks passed
@hackerwins hackerwins deleted the npm-publish branch July 26, 2024 09:55
hackerwins added a commit that referenced this pull request Jul 26, 2024
* Rename @yorkie-ui/components to @yorkie-ui/core

* Add CI workflow for npm package publishing
hackerwins added a commit that referenced this pull request Jul 26, 2024
* Rename @yorkie-ui/components to @yorkie-ui/core

* Add CI workflow for npm package publishing
hackerwins added a commit that referenced this pull request Jul 26, 2024
* Rename @yorkie-ui/components to @yorkie-ui/core

* Add CI workflow for npm package publishing
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.

1 participant