Feature: Buf gen and workflow

.github/workflows/buf.yaml

@@ -0,0 +1,28 @@
+name: Buf
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "proto/**"
+
+jobs:
+  buf:
+    name: Run buf
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: bufbuild/buf-action@v1
+        with:
+          github_token: ${{ github.token }}

buf.gen.yaml

@@ -0,0 +1,21 @@
+version: v2
+managed:
+  enabled: true
+  override:
+    - file_option: go_package_prefix
+      value: github.com/distribworks/dkron/v4/types
+
+inputs:
+  - directory: ./proto
+plugins:
+  #- remote: buf.build/protocolbuffers/go:v1.31.0
+  - local: protoc-gen-go
+    out: types
+    opt:
+      - paths=source_relative
+  #- remote: buf.build/grpc/go:v1.5.1
+  - local: protoc-gen-go-grpc
+    out: types
+    opt:
+      - paths=source_relative
+

proto/dkron.proto

@@ -1,11 +1,12 @@
 // protoc -I proto/ --go_out=types --go_opt=paths=source_relative --go-grpc_out=types --go-grpc_opt=paths=source_relative dkron.proto
 syntax = "proto3";
 
 package types;
-option go_package = "github.com/distribworks/dkron/plugin/types";
 
-import "google/protobuf/timestamp.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.com/distribworks/dkron/plugin/types";
 
 message Job {
   string name = 1;
@@ -54,7 +55,7 @@
   string job_name = 1;
 }
 
-message DeleteJobResponse{
+message DeleteJobResponse {
   Job job = 1;
 }
 
@@ -68,10 +69,10 @@
 
 message Execution {
   string job_name = 1;
-	bool success = 2;
-	bytes output = 3;
-	string node_name = 4;
-	int64 group = 5;
+  bool success = 2;
+  bytes output = 3;
+  string node_name = 4;
+  int64 group = 5;
   uint32 attempt = 6;
   google.protobuf.Timestamp started_at = 7;
   google.protobuf.Timestamp finished_at = 8;
@@ -104,16 +105,16 @@
 
 message RaftServer {
   string id = 1;
-	string node = 2;
-	string address = 3;
-	bool leader = 4;
-	bool voter = 5; 
-	string raft_protocol = 6;
+  string node = 2;
+  string address = 3;
+  bool leader = 4;
+  bool voter = 5;
+  string raft_protocol = 6;
 }
 
 message RaftGetConfigurationResponse {
   repeated RaftServer servers = 1;
-  uint64 index = 2;   
+  uint64 index = 2;
 }
 
 message RaftRemovePeerByIDRequest {
@@ -133,18 +134,18 @@
   repeated Execution executions = 1;
 }
 
 service Dkron {
-  rpc GetJob (GetJobRequest) returns (GetJobResponse);
-  rpc ExecutionDone (ExecutionDoneRequest) returns (ExecutionDoneResponse);
-  rpc Leave (google.protobuf.Empty) returns (google.protobuf.Empty);
-  rpc SetJob (SetJobRequest) returns (SetJobResponse);
-  rpc DeleteJob (DeleteJobRequest) returns (DeleteJobResponse);
-  rpc RunJob (RunJobRequest) returns (RunJobResponse);
-  rpc ToggleJob (ToggleJobRequest) returns (ToggleJobResponse);
-  rpc RaftGetConfiguration (google.protobuf.Empty) returns (RaftGetConfigurationResponse);
-  rpc RaftRemovePeerByID (RaftRemovePeerByIDRequest) returns (google.protobuf.Empty);
-  rpc GetActiveExecutions (google.protobuf.Empty) returns  (GetActiveExecutionsResponse);
-  rpc SetExecution (Execution) returns (google.protobuf.Empty);
+  rpc GetJob(GetJobRequest) returns (GetJobResponse);
+  rpc ExecutionDone(ExecutionDoneRequest) returns (ExecutionDoneResponse);
+  rpc Leave(google.protobuf.Empty) returns (google.protobuf.Empty);
+  rpc SetJob(SetJobRequest) returns (SetJobResponse);
+  rpc DeleteJob(DeleteJobRequest) returns (DeleteJobResponse);
+  rpc RunJob(RunJobRequest) returns (RunJobResponse);
+  rpc ToggleJob(ToggleJobRequest) returns (ToggleJobResponse);
+  rpc RaftGetConfiguration(google.protobuf.Empty) returns (RaftGetConfigurationResponse);
+  rpc RaftRemovePeerByID(RaftRemovePeerByIDRequest) returns (google.protobuf.Empty);
+  rpc GetActiveExecutions(google.protobuf.Empty) returns (GetActiveExecutionsResponse);
+  rpc SetExecution(Execution) returns (google.protobuf.Empty);
 }
 
 message AgentRunRequest {
@@ -153,5 +154,5 @@
 }
 
 service Agent {
-  rpc AgentRun (AgentRunRequest) returns (stream AgentRunStream);
+  rpc AgentRun(AgentRunRequest) returns (stream AgentRunStream);
 }

proto/executor.proto

@@ -2,6 +2,7 @@
 syntax = "proto3";
 
 package types;
+
 option go_package = "github.com/distribworks/dkron/plugin/types";
 
 message ExecuteRequest {
@@ -11,12 +12,12 @@ message ExecuteRequest {
 }
 
 message ExecuteResponse {
-    bytes output = 1;
-    string error = 2;
+  bytes output = 1;
+  string error = 2;
 }
 
 service Executor {
-    rpc Execute (ExecuteRequest) returns (ExecuteResponse);
+  rpc Execute(ExecuteRequest) returns (ExecuteResponse);
 }
 
 message StatusUpdateRequest {

proto/pro.proto

@@ -2,96 +2,98 @@
 syntax = "proto3";
 
 package types;
-option go_package = "github.com/distribworks/dkron/types";
+
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
 
+option go_package = "github.com/distribworks/dkron/types";
+
 // Policy is a policy definition
 message Policy {
-    string name = 1;
-    string rules = 2;
+  string name = 1;
+  string rules = 2;
 }
 
 message ACLPolicyUpsertRequest {
-    Policy policy = 1;
+  Policy policy = 1;
 }
 
 message ACLPolicyUpsertResponse {
-    bool success = 1;
+  bool success = 1;
 }
 
 message ACLPolicyDeleteRequest {
-    string name = 1;
+  string name = 1;
 }
 
 message ACLPolicyDeleteResponse {
-    bool success = 1;
+  bool success = 1;
 }
 
 message ACLPolicyInfoRequest {
-    string name = 1;
+  string name = 1;
 }
 
 message ACLPolicyInfoResponse {
-    Policy policy = 1;
+  Policy policy = 1;
 }
 
 message ACLPolicyListResponse {
-    repeated Policy policies = 1;
+  repeated Policy policies = 1;
 }
 
 enum TokenType {
-    management = 0;
-    client = 1;
+  management = 0;
+  client = 1;
 }
 
 // Token is the representation of a token
 message Token {
-    string accessor = 1;
-    string secret = 2;
-    string name = 3;
-    TokenType type = 4;
-    google.protobuf.Timestamp create_time = 5;
-    google.protobuf.Timestamp expire_time = 6; 
-    repeated string policies = 7;
+  string accessor = 1;
+  string secret = 2;
+  string name = 3;
+  TokenType type = 4;
+  google.protobuf.Timestamp create_time = 5;
+  google.protobuf.Timestamp expire_time = 6;
+  repeated string policies = 7;
 }
 
 message ACLTokenUpsertRequest {
-    Token token = 1;
+  Token token = 1;
 }
 
 message ACLTokenUpsertResponse {
-    bool success = 1;
+  bool success = 1;
 }
 
 message ACLTokenDeleteRequest {
-    string accessor = 1;
+  string accessor = 1;
 }
 
 message ACLTokenDeleteResponse {
-    bool success = 1;
+  bool success = 1;
 }
 
 message ACLTokenInfoRequest {
-    string accessor = 1;
+  string accessor = 1;
 }
 
 message ACLTokenInfoResponse {
-    Token token = 1;
+  Token token = 1;
 }
 
 message ACLTokenListResponse {
-    repeated Token tokens = 1;
+  repeated Token tokens = 1;
 }
 
 // DkronPro is the DkronPro service definition
 service DkronPro {
-    rpc ACLPolicyUpsert (ACLPolicyUpsertRequest) returns (ACLPolicyUpsertResponse);
-    rpc ACLPolicyDelete (ACLPolicyDeleteRequest) returns (ACLPolicyDeleteResponse);
-    rpc ACLPolicyInfo (ACLPolicyInfoRequest) returns (ACLPolicyInfoResponse);
-    rpc ACLPolicyList (google.protobuf.Empty) returns (ACLPolicyListResponse);
-    rpc ACLTokenUpsert (ACLTokenUpsertRequest) returns (ACLTokenUpsertResponse);
-    rpc ACLTokenDelete (ACLTokenDeleteRequest) returns (ACLTokenDeleteResponse);
-    rpc ACLTokenInfo (ACLTokenInfoRequest) returns (ACLTokenInfoResponse);
-    rpc ACLTokenList (google.protobuf.Empty) returns (ACLTokenListResponse);
+  rpc ACLPolicyUpsert(ACLPolicyUpsertRequest) returns (ACLPolicyUpsertResponse);
+  rpc ACLPolicyDelete(ACLPolicyDeleteRequest) returns (ACLPolicyDeleteResponse);
+  rpc ACLPolicyInfo(ACLPolicyInfoRequest) returns (ACLPolicyInfoResponse);
+  rpc ACLPolicyList(google.protobuf.Empty) returns (ACLPolicyListResponse);
+  rpc ACLTokenUpsert(ACLTokenUpsertRequest) returns (ACLTokenUpsertResponse);
+  rpc ACLTokenDelete(ACLTokenDeleteRequest) returns (ACLTokenDeleteResponse);
+  rpc ACLTokenInfo(ACLTokenInfoRequest) returns (ACLTokenInfoResponse);
+  rpc ACLTokenList(google.protobuf.Empty) returns (ACLTokenListResponse);
 }