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 }}

Makefile

@@ -87,8 +87,20 @@ dkron/ui-dist: ui/node_modules ui/public/* ui/src/* ui/src/*/*
 	rm -rf dkron/ui-dist
 	cd ui; yarn build --out-dir ../dkron/ui-dist
 
-proto: types/dkron.pb.go types/executor.pb.go types/pro.pb.go
+# deprecated
+# proto: types/dkron.pb.go types/executor.pb.go types/pro.pb.go
+.PHONY: proto
+proto:
+	@echo "Generating protobuf files using Buf"
+	buf generate
 
+lint: proto-lint
+
+proto-lint:
+	@echo "Linting protobuf files using Buf"
+	buf lint
+
+# deprecated
 types/%.pb.go: proto/%.proto
 	protoc -I proto/ --go_out=types --go_opt=paths=source_relative --go-grpc_out=types --go-grpc_opt=paths=source_relative $<
 

buf.gen.yaml

@@ -0,0 +1,20 @@
+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: gen/proto
+    opt:
+      - paths=source_relative
+  #- remote: buf.build/grpc/go:v1.5.1
+  - local: protoc-gen-go-grpc
+    out: gen/proto
+    opt:
+      - paths=source_relative

buf.yaml

@@ -1,4 +1,11 @@
 version: v2
+breaking:
+  use:
+    - FILE
+  ignore:
+    - "./proto/dkron.proto"
+    - "./proto/executor.proto"
+    - "./proto/pro.proto"
 modules:
   - path: proto
     name: buf.build/distribworks/dkron

builtin/bins/dkron-executor-gcppubsub/gcppubsub.go

@@ -8,8 +8,8 @@ import (
 	"time"
 
 	"cloud.google.com/go/pubsub"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	dkplugin "github.com/distribworks/dkron/v4/plugin"
-	dktypes "github.com/distribworks/dkron/v4/types"
 )
 
 // GCPPubSub plugin publish message to topic when Execute method is called.

builtin/bins/dkron-executor-gcppubsub/gcppubsub_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"cloud.google.com/go/pubsub"
-	dktypes "github.com/distribworks/dkron/v4/types"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/stretchr/testify/assert"
 )
 

builtin/bins/dkron-executor-grpc/grpc.go

@@ -10,8 +10,8 @@ import (
 	"time"
 
 	"github.com/armon/circbuf"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	dkplugin "github.com/distribworks/dkron/v4/plugin"
-	dktypes "github.com/distribworks/dkron/v4/types"
 	"github.com/fullstorydev/grpcurl"
 	"github.com/jhump/protoreflect/grpcreflect"
 	"github.com/pkg/errors"

builtin/bins/dkron-executor-grpc/grpc_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 
 	"github.com/distribworks/dkron/v4/builtin/bins/dkron-executor-grpc/test"
-	dktypes "github.com/distribworks/dkron/v4/types"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
 )

builtin/bins/dkron-executor-kafka/kafka.go

@@ -9,8 +9,8 @@ import (
 	"github.com/IBM/sarama"
 	"github.com/armon/circbuf"
 
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	dkplugin "github.com/distribworks/dkron/v4/plugin"
-	dktypes "github.com/distribworks/dkron/v4/types"
 )
 
 const (

builtin/bins/dkron-executor-kafka/kafka_test.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"testing"
 
-	dktypes "github.com/distribworks/dkron/v4/types"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 )
 
 func TestProduceExecuteWithKey(t *testing.T) {

builtin/bins/dkron-executor-nats/nats.go

@@ -7,8 +7,8 @@ import (
 	"github.com/armon/circbuf"
 	"github.com/nats-io/nats.go"
 
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	dkplugin "github.com/distribworks/dkron/v4/plugin"
-	dktypes "github.com/distribworks/dkron/v4/types"
 )
 
 const (

builtin/bins/dkron-executor-nats/nats_test.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"testing"
 
-	dktypes "github.com/distribworks/dkron/v4/types"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 )
 
 func TestPublishExecute(t *testing.T) {

builtin/bins/dkron-executor-rabbitmq/rabbitmq.go

@@ -5,8 +5,8 @@ import (
 	"errors"
 	"strconv"
 
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	dkplugin "github.com/distribworks/dkron/v4/plugin"
-	dktypes "github.com/distribworks/dkron/v4/types"
 	log "github.com/sirupsen/logrus"
 	"github.com/streadway/amqp"
 )

builtin/bins/dkron-executor-rabbitmq/rabbitmq_test.go

@@ -3,7 +3,7 @@ package main
 import (
 	"testing"
 
-	dktypes "github.com/distribworks/dkron/v4/types"
+	dktypes "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/stretchr/testify/assert"
 )
 

builtin/bins/dkron-processor-files/files_output.go

@@ -6,8 +6,8 @@ import (
 	"os"
 	"strconv"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	log "github.com/sirupsen/logrus"
 )
 

builtin/bins/dkron-processor-files/files_output_test.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"testing"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )

builtin/bins/dkron-processor-fluent/fluent_output.go

@@ -3,8 +3,8 @@ package main
 import (
 	"strconv"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	log "github.com/sirupsen/logrus"
 )
 

builtin/bins/dkron-processor-log/log_output.go

@@ -5,8 +5,8 @@ import (
 	"os"
 	"strconv"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	log "github.com/sirupsen/logrus"
 )
 

builtin/bins/dkron-processor-log/log_output_test.go

@@ -3,8 +3,8 @@ package main
 import (
 	"testing"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )

builtin/bins/dkron-processor-syslog/syslog_output.go

@@ -3,8 +3,8 @@ package main
 import (
 	"strconv"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	gsyslog "github.com/hashicorp/go-syslog"
 	log "github.com/sirupsen/logrus"
 )

builtin/bins/dkron-processor-syslog/syslog_output_test.go

@@ -3,8 +3,8 @@ package main
 import (
 	"testing"
 
+	types "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	"github.com/distribworks/dkron/v4/types"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )

dkron/agent.go

@@ -16,8 +16,8 @@ import (
 	"time"
 
 	"github.com/devopsfaith/krakend-usage/client"
+	typesv1 "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/distribworks/dkron/v4/plugin"
-	proto "github.com/distribworks/dkron/v4/types"
 	"github.com/hashicorp/go-metrics"
 	"github.com/hashicorp/go-uuid"
 	"github.com/hashicorp/memberlist"
@@ -230,7 +230,7 @@ func (a *Agent) Start() error {
 
 		grpcServer := grpc.NewServer(opts...)
 		as := NewAgentServer(a, a.logger)
-		proto.RegisterAgentServer(grpcServer, as)
+		typesv1.RegisterAgentServiceServer(grpcServer, as)
 		go func() {
 			if err := grpcServer.Serve(l); err != nil {
 				a.logger.Fatal(err)
@@ -834,7 +834,7 @@ func (a *Agent) bindRPCAddr() string {
 
 // applySetJob is a helper method to be called when
 // a job property need to be modified from the leader.
-func (a *Agent) applySetJob(job *proto.Job) error {
+func (a *Agent) applySetJob(job *typesv1.Job) error {
 	cmd, err := Encode(SetJobType, job)
 	if err != nil {
 		return err
@@ -870,8 +870,8 @@ func (a *Agent) GetRunningJobs() int {
 }
 
 // GetActiveExecutions returns running executions globally
-func (a *Agent) GetActiveExecutions() ([]*proto.Execution, error) {
-	var executions []*proto.Execution
+func (a *Agent) GetActiveExecutions() ([]*typesv1.Execution, error) {
+	var executions []*typesv1.Execution
 
 	for _, s := range a.LocalServers() {
 		exs, err := a.GRPCClient.GetActiveExecutions(s.RPCAddr.String())

dkron/api.go

@@ -9,7 +9,7 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/distribworks/dkron/v4/types"
+	typesv1 "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/gin-contrib/cors"
 	"github.com/gin-contrib/expvar"
 	"github.com/gin-gonic/gin"
@@ -418,10 +418,10 @@ func (h *HTTPTransport) executionHandler(c *gin.Context) {
 }
 
 func (h *HTTPTransport) membersHandler(c *gin.Context) {
-	mems := []*types.Member{}
+	mems := []*typesv1.Member{}
 	for _, m := range h.agent.serf.Members() {
 		id, _ := uuid.GenerateUUID()
-		mid := &types.Member{m, id, m.Status.String()}
+		mid := &typesv1.Member{m, id, m.Status.String()}
 		mems = append(mems, mid)
 	}
 	c.Header("X-Total-Count", strconv.Itoa(len(mems)))

dkron/execution.go

@@ -6,7 +6,7 @@ import (
 	"strconv"
 	"time"
 
-	proto "github.com/distribworks/dkron/v4/types"
+	proto "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
 

dkron/fsm.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"io"
 
-	dkronpb "github.com/distribworks/dkron/v4/types"
+	dkronpb "github.com/distribworks/dkron/v4/gen/proto/types/v1"
 	"github.com/hashicorp/raft"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/protobuf/proto"