Merge pull request #1 from bavix/develop

[v1.0.0] release

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: gomod
+  directory: /
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.github/workflows/buf-lint.yml

@@ -0,0 +1,20 @@
+name: buf-lint
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  buf-lint:
+    name: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [ '1.22' ]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bufbuild/buf-setup-action@v1
+      - uses: bufbuild/buf-lint-action@v1

.github/workflows/changelog.yml

@@ -0,0 +1,14 @@
+name: update changelog
+
+on:
+  release:
+    types: [released]
+
+permissions: {}
+
+jobs:
+  changelog:
+    permissions:
+      contents: write
+    secrets: inherit
+    uses: bavix/.github/.github/workflows/[email protected]

.github/workflows/golangci-lint.yml

@@ -0,0 +1,27 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [ '1.22' ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.59.1

.github/workflows/semgrep.yml

@@ -0,0 +1,12 @@
+name: semgrep
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+jobs:
+  semgrep:
+    uses: bavix/.github/.github/workflows/[email protected]

.github/workflows/unit.yml

@@ -0,0 +1,25 @@
+name: Unit
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [ '1.22' ]
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+      - name: Test with Go
+        run: go test ./...

.gitignore

@@ -20,3 +20,7 @@
 # Go workspace file
 go.work
 go.work.sum
+
+.idea/
+.trunk/
+.vscode/

.golangci.yml

@@ -0,0 +1,34 @@
+run:
+  timeout: 1m
+linters:
+  enable-all: true
+  disable:
+    # turn on later
+    - godox
+    # deprecated
+    - gomnd
+    - execinquery
+    # not relevant
+    - varnamelen
+    - wrapcheck
+    - paralleltest
+    - exhaustruct
+linters-settings:
+  lll:
+    line-length: 140
+  gci:
+    sections:
+      - Standard
+      - Default
+      - Prefix(github.com/bavix)
+  depguard:
+    rules:
+      main:
+        allow:
+          - $gostd
+          - github.com
+issues:
+  exclude-rules:
+    - path: (.+)_test.go
+      linters:
+        - dupl

README.md

@@ -1,2 +1,10 @@
 # apis
-Storage of protofiles and libraries
+
+apis is a repository that contains proto files and libraries used by a variety of bavix projects.
+
+This repository is a collection of proto files and libraries that are used by a variety of bavix projects. Proto files are used to define the structure and format of data that is exchanged between applications. Libraries are pre-compiled code that can be used by applications to perform common tasks.
+
+The repository is organized into the following directories:
+
+- `proto`: contains the proto files used by the library.
+- `pkg`: contains the compiled libraries.

api/apis/common/v1/uuid.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package apis.common.v1;
+
+option go_package = "./apis/common/v1";
+
+// UUID is a message that represents a UUID.
+//
+// A UUID is composed of two 64-bit values, each representing a part of the UUID.
+// The high part is stored in the high field, and the low part is stored in the
+// low field.
+message UUID {
+    // The high part of the UUID.
+    //
+    // This field contains the high part of the UUID.
+    // It is a 64-bit value that is independent of the low part.
+    int64 high = 1;
+    // The low part of the UUID.
+    //
+    // This field contains the low part of the UUID.
+    // It is a 64-bit value that is independent of the high part.
+    int64 low = 2;
+}

buf.gen.yaml

@@ -0,0 +1,10 @@
+version: v2
+plugins:
+  - local: protoc-gen-go
+    out: pkg
+    opt: 
+      - paths=source_relative
+  - local: protoc-gen-go-grpc
+    out: pkg
+    opt: 
+      - paths=source_relative

buf.yaml

@@ -0,0 +1,3 @@
+version: v2
+modules:
+  - path: api/

go.mod

@@ -0,0 +1,15 @@
+module github.com/bavix/apis
+
+go 1.22.5
+
+require (
+	github.com/google/uuid v1.6.0
+	github.com/stretchr/testify v1.9.0
+	google.golang.org/protobuf v1.34.2
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,18 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
+google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=