Skip to content

Align MiniExcel.Rust NuGet version with Rust 0.5.0 and fix README install docs - #24

Open
shps951023 wants to merge 2 commits into
mainfrom
docs/nuget-readme-install-badge
Open

shps951023 wants to merge 2 commits into
mainfrom
docs/nuget-readme-install-badge

Conversation

@shps951023

@shps951023 shps951023 commented Sep 21, 2026

Copy link
Copy Markdown
Member

Aligns the .NET wrapper version with the Rust crate line: the next NuGet release is 0.5.0-preview.1 (embedding MiniExcel for Rust 0.5.0 natives) instead of 0.1.0-preview.2.

  • MiniExcel.Rust.csproj: version 0.5.0-preview.1 and updated release notes.
  • nuget-release.yml: workflow_dispatch default and example now 0.5.0-preview.1.
  • All six README variants and the benchmark docs: install command changed to --prerelease, NuGet page link added, NuGet version badge (nuget/vpre) added, benchmark references updated to 0.5.0-preview.1.

@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 4116b5c7-5988-4fee-ac57-7ba47a754bef

📥 Commits

Reviewing files that changed from the base of the PR and between fa386bb and cf519e8.

📒 Files selected for processing (11)
  • README.es.md
  • README.fr.md
  • README.ja.md
  • README.md
  • README.zh-CN.md
  • README.zh-TW.md
  • docs/i18n/README.es.md
  • docs/i18n/README.fr.md
  • docs/i18n/README.ja.md
  • docs/i18n/README.zh-CN.md
  • docs/i18n/README.zh-TW.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The main and localized README files now include NuGet badges. Their .NET installation instructions use --prerelease instead of a pinned preview version and link to NuGet package versions.

Changes

NuGet documentation updates

Layer / File(s) Summary
NuGet package badges
README*.md, docs/i18n/README*.md
The README files add badges that link to the MiniExcel.Rust NuGet package.
Prerelease installation guidance
README*.md, docs/i18n/README*.md
The .NET installation commands use --prerelease instead of --version 0.1.0-preview.2. The instructions add NuGet package links where described.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately mentions the README installation documentation update, which is part of the changes. However, the changes also add NuGet badges and do not explicitly align a NuGet version with Ru…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@shps951023 shps951023 changed the title Document NuGet install and badge in READMEs Align MiniExcel.Rust NuGet version with Rust 0.5.0 and fix README install docs Sep 21, 2026
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