chore: release 0.3.0-rc.1 — drop dead refs, ship 2 NuGet packages, honest install docs#18
Merged
Merged
Conversation
Revised the README to emphasize the importance of the CLI tool for obtaining styled components. Added a clear warning about the package's limitations without the CLI, streamlined the quick start section, and provided detailed commands for initializing and adding components. Removed outdated installation steps and clarified the future support for standalone NuGet package usage.
Updated the release workflow to exclude ShellUI.Core and its associated packages from being published to NuGet, as they are internal-only components without a public API. This change streamlines the publishing process, ensuring only relevant packages are pushed to the NuGet repository.
Updated the ShellUI.Core project file to set <IsPackable>false</IsPackable>, indicating that this internal library is not intended for NuGet publishing. This change aligns with the recent workflow adjustments to streamline the release process for internal components.
…project Eliminated the ProjectReference to ShellUI.Components in the ShellUI.CLI project file, streamlining dependencies and aligning with recent project structure changes.
Updated the README to emphasize the CLI-first approach for ShellUI, detailing the installation process and the role of the `ShellUI.Components` NuGet package. Streamlined the instructions for setting up Tailwind CSS and clarified the necessity of using the CLI for styled components, while also addressing the limitations of the NuGet package alone. Enhanced the organization of installation steps and added warnings regarding manual setup requirements.
Modified the ShellUI version suffix in Directory.Build.props from alpha.3 to rc.1, reflecting the transition to a release candidate stage in the development cycle.
…ical fixes and improvements Updated RELEASE_NOTES.md to reflect the release candidate for v0.3.0, detailing integration-tested fixes, critical bug resolutions, and enhancements. Highlights include improved project initialization, corrected component registrations, and the introduction of regression tests for templates. The document serves as the source of truth for the GitHub Release body, ensuring consistency across communications.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Release candidate for
v0.3.0. Three concerns landed together because they're all about "what does shipping look like now":rc.1, prepends a consolidated changelog covering the five fix branches (1–5) that ran during the alpha seriesShellUI.Componentshad a phantomProjectReferencetoShellUI.CoreandShellUI.CLIhad one toShellUI.Components. Both had zerousingdirectives anywhere in source — pure dead weight. The Components→Core ghost ref is exactly what shipped the NU1102 dependency error in alpha.2No source code changes. Tests still pass (53/53).
Changes
Version bump
Directory.Build.props—<ShellUIVersionSuffix>alpha.3</ShellUIVersionSuffix>→rc.1. Propagates to all four packages via the centralized version system.Release notes
docs/RELEASE_NOTES.md— prepended# ShellUI v0.3.0-rc.1 🚦section covering all five fix branches (template escapes, sidebar/theme runtime, init bootstrap, data-table half-install, chart-tooltip CSS) + the test/CI infrastructure that came with them (53 tests, drift detection, CI smoke that scaffolds + builds a real app)Dead project references removed
src/ShellUI.Components/ShellUI.Components.csproj— dropped theProjectReferencetoShellUI.Core. Verified by grep: zerousing ShellUI.CoreorShellUI.Core.*references anywhere insrc/ShellUI.Components/. The ref was a phantom — it propagated to the.nuspecas a runtime dependency, which is what blew up alpha.2 with NU1102 when onlyCore 0.1.0existed on NuGet.src/ShellUI.CLI/ShellUI.CLI.csproj— dropped theProjectReferencetoShellUI.Components. Also zerousingdirectives anywhere insrc/ShellUI.CLI/. The CLI only needsCore(forComponentMetadata,ShellUIConfig,NuGetDependency,ProjectInfo) andTemplates(forComponentRegistry).src/ShellUI.Core/ShellUI.Core.csproj— marked<IsPackable>false</IsPackable>. Was emitting an orphan.nupkgno one pushed. Nowdotnet pack ShellUI.slnproduces exactly the two packages we actually ship.Release workflow
.github/workflows/release.yml— dropped the Core push step and removed Core from the GH Release asset list. Now publishes onlyShellUI.CLI+ShellUI.Componentsto NuGet, mirroring what actually exists.Documentation sweep
README.md— replaced the misleading "Option 1: CLI / Option 2: NuGet" section with one honest "CLI is the install path" section + a clearly-labeled "advanced manual setup" subsection. The package-overview table now says CLI is required and the Components package is optional with a clear use-case description.src/ShellUI.Components/README.md(ships in the NuGet package, shows on nuget.org) — leads with a "Read this first" warning that the package alone doesn't produce styled components, explains why (Tailwind compiles by scanning source files), points users to the CLI, and notes the v0.4.x roadmap.src/ShellUI.CLI/README.md(also on nuget.org) — expanded theshellui initdescription to list everything it actually does now (theme bootstrap, render mode, shellui.js link, MSBuild integration, idempotency) so users know what they get for free.Verification
dotnet pack ShellUI.sln -c Releaseafter cleaning the bin folder produces exactly two packages:ShellUI.Components.0.3.0-rc.1.nuspecconfirms the dependency graph is clean — only the three real runtime deps (Blazor-ApexCharts,Microsoft.AspNetCore.Components.Web,System.Linq.Dynamic.Core), noShellUI.Core:dotnet test ShellUI.Tests -c Release— 53/53 passingTest plan
mainv0.3.0-rc.1release.ymlpublishes exactly 2 nupkgs (CLI + Components) and a GitHub Release with the new top-of-file notes as the bodydotnet tool install -g ShellUI.CLI --version 0.3.0-rc.1worksdotnet add package ShellUI.Components --version 0.3.0-rc.1 --prereleaseresolves without trying to fetchShellUI.Corefrom NuGet (this would have failed in alpha.2)Next step
If the soak window stays quiet: open
chore/release-0.3.0— empty version suffix, README/PROJECT_STATUS "stable" wording,VERSIONING_STRATEGY.mdAPI-contract doc. Then tagv0.3.0. After that,chore/net10-upgradeopens the 0.4 cycle.