Podkrepi.bg types

This repository contains the protobuf contracts and the generated Go types used by podkrepi.bg.

• Linting
• Usage
  • Go
  • C#
• Updating the protos

Linting

Before pushing the repo make sure you lint your proto files. You can do this by running:

task lint_proto

Usage

The section explains how to use the types in different languages.

Go

To use the types in a Go project run:

go get github.com/podkrepi-bg/types/go-types

C#

To use the Nuget package in a C# project, add the following to a nuget.config file in the root directory of the solution.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="podkrepibg-github" value="https://nuget.pkg.github.com/podkrepi-bg/index.json" />
  </packageSources>
  <packageSourceCredentials>
	<podkrepibg-github>
		<add key="Username" value="devops-podkrepi-bg" />
		<add key="ClearTextPassword" value="&#103;hp_wZMwRA1oE6hwdsYDCziboiZFpOkkZs0eaaAt" />
	</podkrepibg-github>	
 </packageSourceCredentials>  
</configuration>

The package can then be installed from the podkrepibg-github Nuget source.

Updating the protos

The easiest way to update the protos is:

• Open the repo in Visual Studio code
• Make sure the Remote Containers extension is installed.
• Click Ctrl/Cmd + Shift + P and select Remote-Containers: Reopen in Container
• The workspace will be automatically opened in a Docker container with all required dependencies to update and build the proto contracts

After the proto files are updated you can run the following command to update the generated Go types:

task build_go_types