Prepare stable 1.0 release

This commit is contained in:
2026-08-17 00:37:53 +10:00
parent 27800da06a
commit 44bb892ddd
6 changed files with 23 additions and 8 deletions
+7
View File
@@ -171,16 +171,23 @@ jobs:
TAG_NAME: ${{ github.ref_name }}
shell: bash
run: |
release_flags=()
if [[ "$PACKAGE_VERSION" == *-* ]]; then
release_flags+=(--prerelease)
fi
if gh release view "$TAG_NAME" --repo "$GITHUB_REPOSITORY" > /dev/null 2>&1; then
gh release upload "$TAG_NAME" artifacts/* eng/openapi/contract.json --clobber --repo "$GITHUB_REPOSITORY"
gh release edit "$TAG_NAME" \
--title "BinaryLane.Api $PACKAGE_VERSION" \
--notes-file release-notes.md \
"${release_flags[@]}" \
--repo "$GITHUB_REPOSITORY"
else
gh release create "$TAG_NAME" artifacts/* eng/openapi/contract.json \
--title "BinaryLane.Api $PACKAGE_VERSION" \
--notes-file release-notes.md \
--verify-tag \
"${release_flags[@]}" \
--repo "$GITHUB_REPOSITORY"
fi
+10 -1
View File
@@ -11,6 +11,14 @@ version.
- Nothing yet.
## [1.0.0] - 2026-08-17
### Added
- First stable release of the BinaryLane v2 .NET client, following the public
`0.1.0-beta.1` validation release.
- Package validation for the `net8.0` and `netstandard2.0` public API assets.
## [0.1.0-beta.1] - 2026-08-16
### Added
@@ -24,5 +32,6 @@ version.
- OpenAPI contract snapshot and change-monitoring automation for BinaryLane
API reference version `0.39.1`.
[Unreleased]: https://github.com/alexhopeoconnor/binarylane-dotnet/compare/v0.1.0-beta.1...HEAD
[Unreleased]: https://github.com/alexhopeoconnor/binarylane-dotnet/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/alexhopeoconnor/binarylane-dotnet/releases/tag/v1.0.0
[0.1.0-beta.1]: https://github.com/alexhopeoconnor/binarylane-dotnet/releases/tag/v0.1.0-beta.1
+1 -3
View File
@@ -20,11 +20,9 @@ committed upstream contract independently of the provider's reference version.
## Install
```bash
dotnet add package BinaryLane.Api --prerelease
dotnet add package BinaryLane.Api
```
Remove `--prerelease` once a stable package version is available.
## Quick start
The registration below reads `BinaryLane:ApiToken` from application
+1 -1
View File
@@ -6,7 +6,7 @@
## 1. Install the package
```bash
dotnet add package BinaryLane.Api --prerelease
dotnet add package BinaryLane.Api
```
## 2. Configure the API token
+2 -2
View File
@@ -35,8 +35,8 @@ policy for this exact repository/workflow/environment identity.
leading `v`.
```bash
git tag -a v0.1.0-beta.1 -m "BinaryLane.Api 0.1.0-beta.1"
git push origin v0.1.0-beta.1
git tag -a v<package-version> -m "BinaryLane.Api <package-version>"
git push origin v<package-version>
```
6. Approve the protected `release` environment in GitHub Actions.
+2 -1
View File
@@ -4,7 +4,7 @@
<PackageId>BinaryLane.Api</PackageId>
<AssemblyName>BinaryLane.Api</AssemblyName>
<RootNamespace>BinaryLane.Api.V2</RootNamespace>
<Version>0.1.0-beta.1</Version>
<Version>1.0.0</Version>
<Authors>Alex Hope-O'Connor</Authors>
<Owners>alex.hope.oconnor</Owners>
<Copyright>Copyright © 2026 Alex Hope-O'Connor</Copyright>
@@ -23,6 +23,7 @@
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<EnablePackageValidation>true</EnablePackageValidation>
<!-- Pack must serialize multi-target nuspec and symbols generation. -->
<BuildInParallel>false</BuildInParallel>
</PropertyGroup>