Skip to content

fix(rust-plugins): 🐛 upate ci config to release packages#125

Merged
CCherry07 merged 1 commit intomainfrom
fix/mdx-publish-fix
Mar 20, 2025
Merged

fix(rust-plugins): 🐛 upate ci config to release packages#125
CCherry07 merged 1 commit intomainfrom
fix/mdx-publish-fix

Conversation

@Maidang1
Copy link
Copy Markdown
Contributor

@Maidang1 Maidang1 commented Mar 20, 2025

Closes: #124

Summary by CodeRabbit

  • New Features
    • Improved release workflows with additional artifact uploads, now supporting extended package handling.
    • Updated plugin releases: Compress is now v0.0.2, MDX is now v0.0.7, and WASM is now v0.0.8 with enhanced capabilities.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2025

Walkthrough

This PR removes an outdated changelog entry for the WASM plugin while updating changelogs and version numbers for three plugins: compress, mdx, and wasm. It also introduces minor formatting adjustments and new artifact upload steps in the GitHub Actions workflows, and expands the release workflow to process an additional package.

Changes

Files Change Summary
.changeset/shy-glasses-sparkle.md Deleted outdated changelog entry for the @farmfe/plugin-wasm patch.
.github/workflows/build.yaml Adjusted formatting and added new steps to conditionally upload mdx and compress artifacts.
.github/workflows/release-rust-plugins.yml Added compress to the list of packages processed during the artifact move step.
rust-plugins/{compress, mdx, wasm}/CHANGELOG.md Added new version entries: compress (0.0.2), mdx (0.0.7), wasm (0.0.8) with CI configuration updates.
rust-plugins/{compress, mdx, wasm}/package.json Updated version numbers: compress (0.0.1 → 0.0.2), mdx (0.0.6 → 0.0.7), wasm (0.0.7 → 0.0.8).

Sequence Diagram(s)

sequenceDiagram
    participant CI as "GitHub Actions Runner"
    participant Workflow as "Build Workflow"
    participant Artifact as "Artifact Service"

    CI->>Workflow: Start build process
    Workflow->>Workflow: Format steps and check mdx artifact path
    alt mdx artifact exists
        Workflow->>Artifact: Upload mdx artifact
    else
        Workflow->>Workflow: Skip mdx upload
    end
    Workflow->>Workflow: Check compress artifact path
    alt compress artifact exists
        Workflow->>Artifact: Upload compress artifact
    else
        Workflow->>Workflow: Skip compress upload
    end
Loading
sequenceDiagram
    participant CI as "GitHub Actions Runner"
    participant Release as "Release Workflow"
    participant Processor as "Artifact Processor"

    CI->>Release: Trigger release process
    Release->>Processor: Process package list (including compress)
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure plugin-mdx has a valid "main" entry ([#124]) No modifications were made to the "main" field in plugin-mdx.

Possibly related PRs

Suggested reviewers

  • CCherry07
  • ErKeLost

Poem

I’m a rabbit in a code garden so bright,
Hopping through patches with delight.
Changelogs updated and workflows in play,
Bugs scurry off when commits save the day.
With version bumps and steps that gleam,
I celebrate changes in my coding dream!
🐰✨


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Copy Markdown

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/build.yaml (1)

72-72: Commented-Out Git Fetch Command:
The commented-out git fetch command on line 72 has been reformatted. Since this code is inactive, consider removing it if it’s no longer needed, or add a clarifying comment regarding its potential future use to avoid confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4ba6c6 and 5f971c2.

📒 Files selected for processing (9)
  • .changeset/shy-glasses-sparkle.md (0 hunks)
  • .github/workflows/build.yaml (3 hunks)
  • .github/workflows/release-rust-plugins.yml (1 hunks)
  • rust-plugins/compress/CHANGELOG.md (1 hunks)
  • rust-plugins/compress/package.json (1 hunks)
  • rust-plugins/mdx/CHANGELOG.md (1 hunks)
  • rust-plugins/mdx/package.json (1 hunks)
  • rust-plugins/wasm/CHANGELOG.md (1 hunks)
  • rust-plugins/wasm/package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .changeset/shy-glasses-sparkle.md
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: call-rust-build / Build and Upload Artifacts - win32-arm64-msvc
  • GitHub Check: call-rust-build / Build and Upload Artifacts - win32-ia32-msvc
  • GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-arm64
  • GitHub Check: call-rust-build / Build and Upload Artifacts - linux-arm64-gnu
  • GitHub Check: call-rust-build / Build and Upload Artifacts - linux-arm64-musl
  • GitHub Check: call-rust-build / Build and Upload Artifacts - win32-x64-msvc
  • GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-x64
  • GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-musl
  • GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-gnu
🔇 Additional comments (11)
rust-plugins/wasm/CHANGELOG.md (1)

3-7: Clear Version Update & Patch Note
The new changelog entry for version 0.0.8 clearly documents the rewrite—especially noting the enhanced capability to parse WASM binary imports. Ensure that this version bump remains in sync with the update in rust-plugins/wasm/package.json.

rust-plugins/compress/CHANGELOG.md (1)

1-7: Well-Formatted Changelog for Compress Plugin
The introduction of version 0.0.2 along with the clear note "update ci config to release packages" is concise and follows the project's changelog conventions. No further changes are necessary here.

rust-plugins/mdx/package.json (1)

3-3: Accurate Version Bump
Updating the version from "0.0.6" to "0.0.7" is correct and aligns with the changelog modifications. Confirm that any references to this package version elsewhere are updated if necessary.

rust-plugins/wasm/package.json (1)

3-3: Consistent Version Update for WASM Plugin
The change to version "0.0.8" is consistent with the changelog entry and accurately reflects the new functionality.

rust-plugins/mdx/CHANGELOG.md (1)

3-7: Clear Changelog Entry for MDX Plugin
The new version 0.0.7 entry with the patch note "update ci config to release packages" is well documented and follows the established format.

rust-plugins/compress/package.json (1)

3-3: Version Bump Update:
The "version" field has been updated to "0.0.2", which aligns with the intended release. Please ensure that this change is also reflected in the corresponding changelog and that it complies with the project's semantic versioning standards.

.github/workflows/release-rust-plugins.yml (1)

38-38: Inclusion of compress in Artifact Move Step:
The compress package has now been added to the list in the artifacts moving loop. Verify that the expected directory structure (./rust-plugins/compress/npm/${{ matrix.settings.abi }}) exists and that the build process for the compress plugin produces the required artifact.

.github/workflows/build.yaml (4)

93-95: Formatting Consistency for OS X Cross Setup:
The osx-version parameter is now wrapped in double quotes, which is consistent with YAML styling best practices and improves readability.


97-98: Uniform Version Formatting for Zig Setup:
The version for the Zig setup is now set as "0.13.0" (using double quotes), ensuring consistency in string formatting across the workflow.


193-199: New Artifact Upload for mdx Plugin:
A new step has been added to upload artifacts for the mdx plugin. Please confirm that the build process correctly generates the artifact (index.farm) in the folder ./rust-plugins/mdx/npm/${{ matrix.settings.abi }} and that downstream processes expect this file.


200-204: New Artifact Upload for compress Plugin:
This new step uploads artifacts for the compress plugin. Ensure that the build process generates index.farm in the directory ./rust-plugins/compress/npm/${{ matrix.settings.abi }}, matching the patterns used by the other plugin upload steps.

@CCherry07 CCherry07 merged commit 59d8f2c into main Mar 20, 2025
11 checks 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.

[plugin-mdx]Error: Cannot find module '~~~/index.farm'

3 participants