From 44bb892ddd9aaeb045123e8591b420bc4d9ff3d9 Mon Sep 17 00:00:00 2001 From: Alex Hope-O'Connor Date: Mon, 17 Aug 2026 00:37:53 +1000 Subject: [PATCH] Prepare stable 1.0 release --- .github/workflows/publish.yml | 7 +++++++ CHANGELOG.md | 11 ++++++++++- README.md | 4 +--- docs/getting-started.md | 2 +- docs/releasing.md | 4 ++-- src/BinaryLane.Api/BinaryLane.Api.csproj | 3 ++- 6 files changed, 23 insertions(+), 8 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 426d9b8..3829536 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b746b1..54f3a29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 8cabf1f..fcdeb43 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/getting-started.md b/docs/getting-started.md index 9ef5512..cf2bfb1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 diff --git a/docs/releasing.md b/docs/releasing.md index 304f140..f037d9f 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -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 -m "BinaryLane.Api " +git push origin v ``` 6. Approve the protected `release` environment in GitHub Actions. diff --git a/src/BinaryLane.Api/BinaryLane.Api.csproj b/src/BinaryLane.Api/BinaryLane.Api.csproj index 19382a1..7f3c5e3 100644 --- a/src/BinaryLane.Api/BinaryLane.Api.csproj +++ b/src/BinaryLane.Api/BinaryLane.Api.csproj @@ -4,7 +4,7 @@ BinaryLane.Api BinaryLane.Api BinaryLane.Api.V2 - 0.1.0-beta.1 + 1.0.0 Alex Hope-O'Connor alex.hope.oconnor Copyright © 2026 Alex Hope-O'Connor @@ -23,6 +23,7 @@ true snupkg true + true false