From f76eb29f389cb277de38f50373e70b373881eca0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Villenas?= Date: Tue, 15 Sep 2026 16:00:16 -0500 Subject: [PATCH] docs: declare the public API stable and prepare for 1.0.0 Replaces README's "APIs and behavior may change before the first stable release" with an explicit stability statement, now that the full release validation (docs/Compatibility.md) is complete and the minimum-version commitment has been confirmed. Updates every stale beta.4/beta.5 version reference (README's version matrix and install command, Usage-Guide's install command, Release-Process's "next planned release" and example tag commands) to target 1.0.0, and removes Directory.Build.props's VersionSuffix so a local dotnet pack no longer produces a beta-labeled artifact. The release workflow itself already derives the published version from the git tag, so this only affects local/dev builds and documentation, not what previously shipped. Also corrects README's "build-verified through 31.7.2" to 31.8.4 to match the current Compatibility.md record. Tagging and publishing v1.0.0 itself are separate, deliberate follow-up actions, not part of this change. --- Directory.Build.props | 1 - README.md | 10 +++++----- docs/Release-Process.md | 6 +++--- docs/Usage-Guide.md | 2 +- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index b495555..304f032 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -6,7 +6,6 @@ Copyright © 2026 SimpleA and Andres Villenas $(Company)™ 1.0.0 - beta.4 false MIT diff --git a/README.md b/README.md index f7488ad..1887f33 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ for form submissions, bulk and filtered submission removal, and a native administration action for cloning forms without copying submissions or runtime integrations. -The project is developed and maintained by Andres Villenas at SimpleA. APIs and -behavior may change before the first stable release. +The project is developed and maintained by Andres Villenas at SimpleA. The +public API and behavior are considered stable as of `1.0.0`. ## Requirements @@ -19,9 +19,9 @@ behavior may change before the first stable release. | Xperience Version | Library Version | | ----------------- | --------------- | -| 30.11.0 or newer | 1.0.0-beta.4 | +| 30.11.0 or newer | 1.0.0 | -The package is build-verified through 31.7.2 and runtime smoke-tested on 31.1.2. +The package is build-verified through 31.8.4 and runtime smoke-tested on 31.1.2. Newer releases may work but require compatibility validation. See the [compatibility policy](./docs/Compatibility.md). @@ -35,7 +35,7 @@ Newer releases may work but require compatibility validation. See the Add the package to your application using the .NET CLI: ```powershell -dotnet add package XperienceCommunity.FormsToolkit --version 1.0.0-beta.4 +dotnet add package XperienceCommunity.FormsToolkit --version 1.0.0 ``` Register the toolkit and its packaged administration extension: diff --git a/docs/Release-Process.md b/docs/Release-Process.md index 6b5a494..3009d22 100644 --- a/docs/Release-Process.md +++ b/docs/Release-Process.md @@ -29,7 +29,7 @@ GitHub identity for a short-lived NuGet.org credential immediately before publis - Prerelease: `beta.N` while gathering feedback and `rc.N` when preparing a stable release. -The next planned release is `1.0.0-beta.5`. +The next planned release is `1.0.0`, the first stable release. ## Publishing a release @@ -38,8 +38,8 @@ The next planned release is `1.0.0-beta.5`. 3. Create and push an annotated tag: ```powershell - git tag -a v1.0.0-beta.5 -m "Release 1.0.0-beta.5" - git push origin v1.0.0-beta.5 + git tag -a v1.0.0 -m "Release 1.0.0" + git push origin v1.0.0 ``` 4. Approve the `nuget-release` environment deployment. diff --git a/docs/Usage-Guide.md b/docs/Usage-Guide.md index 6d42d11..4d22dd4 100644 --- a/docs/Usage-Guide.md +++ b/docs/Usage-Guide.md @@ -14,7 +14,7 @@ Install the toolkit package in the Xperience application: ```powershell -dotnet add package XperienceCommunity.FormsToolkit --version 1.0.0-beta.4 +dotnet add package XperienceCommunity.FormsToolkit --version 1.0.0 ``` Register the toolkit after registering Xperience services: