chore(platform): prepare v1.0.0-preview.1 release baseline#3
Conversation
There was a problem hiding this comment.
Pull request overview
Prepares the repository for the first public preview release of MyBatis.NET.SqlServer v1.0.0-preview.1, aligning package identity/versioning, updating release-facing documentation, and tightening CI/CD to build/test targeted projects and publish only the SQL Server runtime package.
Changes:
- Renamed/runtime package alignment:
MyBatis.NET.SqlServerwith version1.0.0-preview.1. - Refreshed docs/changelog/release summaries for the v1 preview/stable roadmap and new package naming.
- Updated GitHub Actions workflows to build specific projects, run unit tests, and publish only
MyBatis.NET.SqlServerpackages.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| Tools/README.md | Updates generator docs to reflect returnSingle requirement from v1.0.0+. |
| SQL_LOGGING.md | Updates package install/name references to MyBatis.NET.SqlServer. |
| RELEASE_v2.0.0.md | Removes outdated v2 release summary document. |
| RELEASE_v1.0.0.md | Adds stable release summary doc for v1.0.0. |
| RELEASE_v1.0.0-preview.1.md | Adds preview release summary + validation checklist. |
| README.md | Updates badges/install instructions/version history for MyBatis.NET.SqlServer. |
| MyBatis.NET.csproj | Changes PackageId and Version to the v1 preview baseline and updates release notes/description. |
| CONTRIBUTING.md | Updates version examples and adds GitHub Flow branching guidance. |
| CHANGELOG.md | Rewrites changelog to focus on MyBatis.NET.SqlServer and the v1 preview baseline. |
| .github/workflows/publish.yml | Adds test execution and restricts publishing to MyBatis.NET.SqlServer*.nupkg. |
| .github/workflows/dotnet.yml | Builds runtime/tests explicitly and runs tests on the test project. |
| .github/ISSUE_TEMPLATE/bug_report.md | Updates the example version in the bug report template. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| run: dotnet build MyBatis.NET.csproj --configuration Release --no-restore | ||
|
|
||
| - name: 🧪 Run Tests | ||
| run: dotnet test Tests/MyBatis.NET.Tests.csproj --configuration Release --no-build --verbosity normal --filter "Category!=Integration" |
There was a problem hiding this comment.
dotnet test Tests/MyBatis.NET.Tests.csproj --no-build runs after building only MyBatis.NET.csproj, so the test project binaries likely won't exist on a clean runner and the publish workflow can fail. Build the test project before this step (or remove --no-build so dotnet test performs the build).
| run: dotnet test Tests/MyBatis.NET.Tests.csproj --configuration Release --no-build --verbosity normal --filter "Category!=Integration" | |
| run: dotnet test Tests/MyBatis.NET.Tests.csproj --configuration Release --verbosity normal --filter "Category!=Integration" |
| - **Runtime Proxy**: Automatically generate mapper implementations using dynamic proxies | ||
| - **Optimized Performance**: Compiled Expression Trees with smart caching (2-3x faster for repeated queries) | ||
| - **Code Generator**: Auto-generate C# interfaces from XML mappers (keeps them in sync!) |
There was a problem hiding this comment.
The README claims “smart caching (2-3x faster for repeated queries)”, but the current ResultMapper implementation doesn’t use its _cache and recompiles the mapping lambda per call, so this performance/caching statement appears inaccurate. Either adjust the wording to match the current behavior, or implement and use the intended cache before advertising it.
| - Result mapping based on compiled expression trees | ||
| - Result mapper cache optimized by type + column schema with stats APIs: | ||
| - `ResultMapper.GetCacheStats()` | ||
| - `ResultMapper.ClearCache()` |
There was a problem hiding this comment.
The changelog lists ResultMapper.GetCacheStats(), ResultMapper.ClearCache(), and “cache optimized by type + column schema”, but these APIs (and schema-based caching) don’t exist in the current Core/ResultMapper.cs implementation. Please update the changelog to reflect the actual public surface area, or add the documented APIs before the preview release.
| - Package: `MyBatis.NET.SqlServer` | ||
| - Version: `1.0.0` | ||
| - Release date: `2026-03-11` | ||
|
|
There was a problem hiding this comment.
This file presents v1.0.0 as already released (explicit version + release date), but elsewhere in the repo (README/CHANGELOG) v1.0.0 is described as “Planned Stable” while this PR is preparing 1.0.0-preview.1. Consider marking v1.0.0 as planned/TBD (or removing this file until the stable release) to avoid conflicting release messaging.
| - Mapper proxy execution via `SqlSession` | ||
| - SQL and parameter logging support | ||
| - Async query/execute APIs | ||
| - Result mapper cache optimization with performance statistics |
There was a problem hiding this comment.
The highlight “Result mapper cache optimization with performance statistics” doesn’t match the current ResultMapper implementation (the declared cache isn’t used, and there are no public stats APIs). Please remove/adjust this bullet unless the caching/stats features are implemented before release.
| - Result mapper cache optimization with performance statistics |
| - Framework: [e.g. .NET 8.0] | ||
| - Database: [e.g. SQL Server 2022] | ||
| - MyBatis.NET Version [e.g. 2.0.0] | ||
| - MyBatis.NET Version [e.g. 1.0.0] |
There was a problem hiding this comment.
The template’s example version is 1.0.0, but the repo/package baseline in this PR is 1.0.0-preview.1 (MyBatis.NET.csproj). Updating the example to 1.0.0-preview.1 would reduce confusion for users filing issues against the preview package line.
| - MyBatis.NET Version [e.g. 1.0.0] | |
| - MyBatis.NET Version [e.g. 1.0.0-preview.1] |
|
|
||
| **Environment:** | ||
| - MyBatis.NET version: 2.0.0 | ||
| - MyBatis.NET version: 1.0.0 |
There was a problem hiding this comment.
The bug report example hard-codes MyBatis.NET version: 1.0.0, but this PR’s release baseline is 1.0.0-preview.1. Consider using the preview version in the example (or wording like “e.g. 1.0.0-preview.1”) so reports match what users can actually install right now.
| - MyBatis.NET version: 1.0.0 | |
| - MyBatis.NET version: e.g. 1.0.0-preview.1 |
Summary
Notes