Performing a Release

Release Procedure

Ensure latest Gateway protobuf file

Goto the 'generate-grpc/' and ensure that the zeebe version is the latest released Zeebe version. Run 'gen-grpc.sh', which downloads the protobuf file and generates the Gateway.cs and GatewayGrpc.cs files in the Client/Impl/proto directory.

Build the Client project

Use your IDE or dotnet to build a release artifact.

Nuget release

For reference https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package-using-visual-studio-net-framework

Adjust the .nuspec file

Adjust the Client.nuspec file, modify the release notes and version number.

vim Client/Client.nuspec

Pack the nuget package

cd Client/
nuget pack Client.csproj -Prop Configuration=Release
# alternative (if not created per default by build)
dotnet pack --configuration Release --no-restore

Use the release configuration if you build an release artifact under bin/release.

Publish the nuget package

Note: You need the API key from nuget.org to publish the release.

nuget push zb-client.0.2.0.nupkg API_KEY -Source https://api.nuget.org/v3/index.json
# alternative
dotnet nuget push Client/bin/Release/zb-client.1.0.0.nupkg -k $(cat credentials/APIKEY) -s  https://api.nuget.org/v3/index.json

You should see a similar output:

Pushing zb-client.0.2.0.nupkg to 'https://www.nuget.org/api/v2/package'...
  PUT https://www.nuget.org/api/v2/package/
  Created https://www.nuget.org/api/v2/package/ 172575ms
Your package was pushed.

Test the release

Wait until the nuget package was verified.

• Create a new example project which uses the released package.
• Download the latest Zeebe distribution.
• Start the broker with the SimpleMonitor Exporter
• Start Simple Monitor
• Verify your client example with the simple monitor

Release on github

Create a new release with the corresponding version on github.