Kuka.Iiqka.Sdk.Protobuf.DependencyResolver 1.0.0

Kuka.Iiqka.Sdk.Protobuf.DependencyResolver

The Protobuf DependencyResolver resolves protobuf dependencies, located in depending nugets or projects, for protobuf code generation with Grpc.Tools.

Enable resolver

To enable the dependency resolver, it must only be added as build dependency to the project. It automatically integrates into the build.

<PackageReference Include="Kuka.Iiqka.Sdk.Protobuf.DependencyResolver" Version="<version>">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>

Lookup locations

The protobuf files to resolve must be located in the following location:

• For ProjectReferences use: Protos
• For PackageReferences use: protos

This convention must be respected by the providing nugets.

Special handling of Google.Api.CommonProtos

The Protobuf DependencyResolver contains all protobuf files used in Google.Api.CommonProtos. So it is possible to use these protobuf messages as import.

But the generated code of these protos is not included and can be obtained by referencing Google.Api.CommonProtos:

<ItemGroup>
  <PackageReference Include="Google.Api.CommonProtos" Version="<version>" />
</ItemGroup>

How to provide protobuf files in a nuget

To add the protobuf files into a nuget, the following tasks must be added to the corresponding .csproj file.

• Use netstandard2.0 as target framework

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  

• Pack protobuf files into nuget

  • Locate the protos in a folder named Protos

  • Include protobuf files into nuget

    <ItemGroup>
    
      <None Include="Protos\**\*.proto" PackagePath="protos/" Pack="true" />
    </ItemGroup>
    

• Optionally: Add generated source code of protobuf files to nuget

  <ItemGroup>
  
    <PackageReference Include="Google.Protobuf" Version="<version>" />
  
  
    <PackageReference Include="Grpc.Tools" Version="<version>">
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
      <PrivateAssets>all</PrivateAssets>
    </PackageReference>
  
  
    <Protobuf Include="Protos\**\*.proto" ProtoRoot="Protos" />
  </ItemGroup>
  

• If required use this dependency resolver as described in Enable resolver