Skip to content

Commit 525025d

Browse files
committed
Merge branch 'release/2.8.3'
2 parents 70d15b1 + 099dd1f commit 525025d

5 files changed

Lines changed: 35 additions & 9 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,8 @@ jobs:
6161
GOTENBERG_PASSWORD: testpass
6262

6363
- name: Pack
64-
run: dotnet pack -c Release -p:PackageVersion=${{ steps.gitversion.outputs.FullSemVer }} -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
65-
64+
run: dotnet pack src/Gotenberg.Sharp.Api.Client/Gotenberg.Sharp.Api.Client.csproj -c Release -p:PackageVersion=${{ steps.gitversion.outputs.FullSemVer }} -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
65+
6666
- name: Publish
6767
if: github.event_name != 'pull_request' && (github.ref_name == 'master')
68-
run: |
69-
dotnet nuget push **/*.nupkg --source 'https://api.nuget.org/v3/index.json' -k ${{ secrets.NUGETKEY }} --skip-duplicate
70-
dotnet nuget push **/*.snupkg --source 'https://api.nuget.org/v3/index.json' -k ${{ secrets.NUGETKEY }} --skip-duplicate
68+
run: dotnet nuget push src/Gotenberg.Sharp.Api.Client/bin/Release/*.nupkg --source 'https://api.nuget.org/v3/index.json' -k ${{ secrets.NUGETKEY }} --skip-duplicate

CHANGES.MD

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Release History
22

3+
## v2.8.3
4+
- **Configuration Improvements:**
5+
- Added optional `Action<GotenbergSharpClientOptions>` parameter to `AddGotenbergSharpClient()` extension methods
6+
- Allows programmatic configuration of options directly when registering the client
7+
- Made `GotenbergSharpClientOptions` optional in DI - falls back to empty options if not configured
8+
- Supports hybrid configuration (appsettings.json + programmatic overrides)
9+
- Updated README with configuration examples (basic, programmatic, and hybrid)
10+
- **Documentation Improvements (PR #65):**
11+
- Added comprehensive XML documentation to all public APIs
12+
- Added Gotenberg documentation links to all client methods
13+
- Enhanced IntelliSense with parameter details, valid value ranges, and usage notes
14+
- Documented exception types with clear error handling guidance
15+
- Updated README to highlight IntelliSense documentation features
16+
- **Examples & Quality (PR #66):**
17+
- Converted LinqPad examples to .NET 8 console applications
18+
- Fixed Footer/Header swap bug in examples
19+
- Added proper resource disposal with CancellationToken.None to all CopyToAsync calls
20+
- Added validation and null-forgiving operators to BasicAuth handler registration
21+
- Fixed GitHub Actions build by adding example project build configurations
22+
- **Build & Packaging Fixes:**
23+
- Fixed NuGet packaging to only publish the client library (not example projects)
24+
- Replaced deprecated `PackageLicenseUrl` with `PackageLicenseExpression`
25+
- Fixed GitHub Actions to only pack and push the Gotenberg.Sharp.Api.Client package
26+
- Removed redundant symbol package push (handled automatically with main package)
27+
328
## v2.8.1
429
- Added strongly-typed cookie support for Gotenberg API
530
- Added basic authentication support

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
</h1>
44

55
[![NuGet version](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client.svg)](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client)
6-
[![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client)
6+
[![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client)
77
![Build status](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/actions/workflows/deploy.yml/badge.svg)
88

99
⭐ For Gotenberg v7 & v8 ⭐
1010

11+
📋 [Release History & Changes](CHANGES.MD)
12+
1113
.NET C# Client for interacting with the [Gotenberg](https://gotenberg.dev/) v7 & v8 micro-service's API. [Gotenberg](https://github.com/gotenberg/gotenberg) is a [Docker-powered stateless API](https://hub.docker.com/r/gotenberg/gotenberg/) for converting & merging HTML, Markdown and Office documents to PDF. The client supports a configurable [Polly](http://www.thepollyproject.org/) **retry policy** with exponential backoff for handling transient exceptions.
1214

1315
# Getting Started

examples/Directory.Build.props

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<TargetFramework>net8.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
7+
<IsPackable>false</IsPackable>
78
</PropertyGroup>
89

910
<ItemGroup>

src/Gotenberg.Sharp.Api.Client/Gotenberg.Sharp.Api.Client.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</PropertyGroup>
1515

1616
<PropertyGroup Label="PackageInfo">
17-
<Version>2.8.2</Version>
17+
<Version>2.8.3</Version>
1818
<PackageTags>Gotenberg pdf C# API client unoconv</PackageTags>
1919
<Description>
2020
C# API client for interacting with the Gotenberg v7 &amp; v8 micro-service's API, a docker-powered stateless API for converting &amp; merging HTML, Markdown and Office documents to PDF. The client supports a configurable Polly retry policy with exponential back-off for handling transient exceptions.
2121
</Description>
2222
<IncludeSymbols>True</IncludeSymbols>
2323
<PackageReleaseNotes>
24-
v2.8.2 - Added optional Action&lt;GotenbergSharpClientOptions&gt; parameter to AddGotenbergSharpClient for programmatic configuration. Options now optional in DI.
24+
v2.8.3 - Added programmatic configuration support. Comprehensive documentation improvements. Fixed NuGet packaging issues. See CHANGES.MD for full details.
2525
v2.8.1 - Added strongly-typed cookie support. Added basic authentication support. Added SinglePage page property. Fixed margins bug. Project restructure (moved /lib to /src).
2626
v2.8 - Improving handling of PDF formatting and added flatten support.
2727
v2.7 - Fixes issue with "Inches".
@@ -33,7 +33,7 @@
3333
v2.1 - Added Trace Support. Fixed extra webhook header support.
3434
v2.0 - Upgraded to support Gotenberg v7 -- this version no longer works with Gotenberg v6.
3535
</PackageReleaseNotes>
36-
<PackageLicenseUrl>http://www.apache.org/licenses/LICENSE-2.0</PackageLicenseUrl>
36+
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
3737
<PackageProjectUrl>https://github.com/ChangemakerStudios/GotenbergSharpApiClient</PackageProjectUrl>
3838
<PackageIconUrl>https://raw.githubusercontent.com/ChangemakerStudios/GotenbergSharpApiClient/master/resources/gotenberg-sharp-client.png</PackageIconUrl>
3939
<PackageIcon>gotenberg-sharp-client.png</PackageIcon>

0 commit comments

Comments
 (0)