Skip to content

docs: declare the public API stable and prepare for 1.0.0 #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andresvillenas merged 1 commit into from
Sep 15, 2026
Merged

docs: declare the public API stable and prepare for 1.0.0 #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<Copyright>Copyright © 2026 SimpleA and Andres Villenas</Copyright>
<Trademark>$(Company)™</Trademark>
<VersionPrefix>1.0.0</VersionPrefix>
<VersionSuffix>beta.4</VersionSuffix>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PackageLicenseExpression>MIT</PackageLicenseExpression>

Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ 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

### Library Version Matrix

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

Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions docs/Release-Process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/Usage-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading