gRPCのスキーマ定義

.github/workflows/proto-ci.yml

@@ -0,0 +1,48 @@
+name: Protobuf CI
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "proto/**"
+  pull_request:
+    paths:
+      - "proto/**"
+
+jobs:
+  buf:
+    name: buf check
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bufbuild/buf-action@v1
+        with:
+          version: 1.49.0
+          push: false
+
+  buf-gen:
+    name: buf generate
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bufbuild/buf-action@v1
+        with:
+          version: 1.49.0
+          setup_only: true
+
+      - name: Generate
+        run: buf generate
+        shell: bash
+
+      - name: Exit if diff exists
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "Generated files are different from committed files. Please run 'buf generate' and commit the changes."
+            exit 1
+          fi
+        shell: bash

README.md

@@ -18,3 +18,7 @@ CLIENT_SECRET=my-client-secret
 ```
 traQで作成するClientは リダイレクトURL に `http://localhost:8080/api/oauth2/callback`、スコープに `openid`, `profile` を指定します。
 `task run-server` で portal server が 8080番 ポートで起動します。
+
+## protobuf について
+
+[proto/README.md](proto/README.md) を参照してください。

Taskfile.yml

@@ -13,7 +13,7 @@ tasks:
     cmds:
       - go test -cover -race ./...
 
-  gen:
+  go:gen:
     cmds:
       - task: up-db
       - go generate ./...
@@ -26,6 +26,19 @@ tasks:
       - server/openapi/*.go
       - server/models/**/*.go
 
+  proto:gen:
+    cmds:
+      - buf generate
+    sources:
+      - proto/**/*.proto
+    generates:
+      - gen/**
+
+  gen:
+    cmds:
+      - task: go:gen
+      - task: proto:gen
+
   up-db:
     cmds:
       - docker compose up -d --wait db

buf.gen.yaml

@@ -0,0 +1,16 @@
+version: v2
+managed:
+  enabled: true
+  override:
+    - file_option: go_package_prefix
+      value: github.com/traPtitech/piscon-portal-v2/proto/gen
+plugins:
+  - remote: buf.build/grpc/go:v1.5.1
+    out: gen
+    opt:
+      - paths=source_relative
+  # dependencies
+  - remote: buf.build/protocolbuffers/go:v1.36.1
+    out: gen
+    opt:
+      - paths=source_relative

buf.yaml

@@ -0,0 +1,10 @@
+# For details on buf.yaml configuration, visit https://buf.build/docs/configuration/v2/buf-yaml
+version: v2
+lint:
+  use:
+    - STANDARD
+breaking:
+  use:
+    - FILE
+modules:
+  - path: "proto"