Skip to content

Commit c9d5f21

Browse files
elizabethhealyelizabethhealy
authored
feat(ci): Add a workflow to update the generated code for new protocol/go versions (#767)
* add a workflow to update the pbs * trigger on PR * correct platform location * add gh token to env * remove extra file after use * detect changes on regen * test with latest version * remove, test changes * test for signed commits * try with api * push the new branch * use a shorter file name in the message * fix for non existing files * run slightly after midnight to avoid queues
1 parent 9bb6266 commit c9d5f21

File tree

3 files changed

+201
-4
lines changed

3 files changed

+201
-4
lines changed

‎.github/workflows/update-protos.yaml‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
name: "Update protos"
2+
3+
on:
4+
schedule:
5+
- cron: "17 0 * * *" # Runs daily at 00:17 UTC
6+
7+
workflow_call:
8+
inputs:
9+
tag:
10+
required: true
11+
type: string
12+
workflow_dispatch:
13+
inputs:
14+
tag:
15+
description: "The new tag for targeting the RPC protocol buffers."
16+
required: true
17+
default: "protocol/go/v0.13.0"
18+
19+
jobs:
20+
update-platform-protos:
21+
runs-on: ubuntu-latest
22+
permissions:
23+
contents: write
24+
pull-requests: write
25+
actions: read
26+
27+
steps:
28+
- name: Checkout web-sdk repository
29+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5
30+
with:
31+
path: web-sdk
32+
persist-credentials: true
33+
34+
- name: Set up GitHub CLI as Actions bot
35+
env:
36+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
37+
run: |
38+
gh auth setup-git
39+
git config --global user.name "github-actions[bot]"
40+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
41+
42+
- name: Fetch latest semver tag for protocol/go
43+
id: fetch-latest-tag
44+
run: |
45+
if [ -z "${{ github.event.inputs.tag }}" ]; then
46+
LATEST_TAG=$(git ls-remote --tags https://github.com/opentdf/platform.git | \
47+
grep "refs/tags/protocol/go" | \
48+
sed 's|.*/||' | \
49+
sort -V | \
50+
tail -n1)
51+
echo "LATEST_TAG=protocol/go/$LATEST_TAG" >> "$GITHUB_ENV"
52+
else
53+
echo "LATEST_TAG=${{ github.event.inputs.tag }}" >> "$GITHUB_ENV"
54+
fi
55+
56+
- name: Check if update is needed
57+
working-directory: ./web-sdk
58+
id: check-update
59+
run: |
60+
CURRENT_TAG=$(jq -r '.["tag"]' lib/platform-proto-version.json)
61+
if [ "$CURRENT_TAG" = "$LATEST_TAG" ]; then
62+
echo "Platform branch is already up-to-date."
63+
echo "no_updates=true" >> "$GITHUB_OUTPUT"
64+
exit 0
65+
fi
66+
echo "CURRENT_TAG=$CURRENT_TAG" >> "$GITHUB_ENV"
67+
68+
- name: Check for existing PR
69+
if: steps.check-update.outputs.no_updates != 'true'
70+
id: check-pr
71+
working-directory: ./web-sdk
72+
run: |
73+
EXISTING_PR=$(gh pr list --head update-platform-protos --json number --jq '.[0].number')
74+
if [ -n "$EXISTING_PR" ]; then
75+
echo "EXISTING_PR=$EXISTING_PR" >> "$GITHUB_OUTPUT"
76+
fi
77+
env:
78+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
79+
80+
- name: Check out existing PR
81+
working-directory: ./web-sdk
82+
if: steps.check-pr.outputs.EXISTING_PR != '' && steps.check-update.outputs.no_updates != 'true'
83+
run: |
84+
git fetch origin update-platform-protos:update-platform-protos
85+
git checkout update-platform-protos
86+
87+
- name: Clone platform repo at protocol/go tag
88+
if: steps.check-update.outputs.no_updates != 'true'
89+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5
90+
with:
91+
path: platform
92+
repository: opentdf/platform
93+
ref: ${{ env.LATEST_TAG }}
94+
persist-credentials: true
95+
96+
- uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 #v5.0.0
97+
if: steps.check-update.outputs.no_updates != 'true'
98+
with:
99+
node-version: '22'
100+
cache: 'npm'
101+
cache-dependency-path: './web-sdk/lib/package-lock.json'
102+
103+
- name: Regen pb files
104+
id: update-platform-protos
105+
if: steps.check-update.outputs.no_updates != 'true'
106+
working-directory: ./web-sdk/lib
107+
run: |
108+
npm ci
109+
cd ..
110+
./scripts/platform.sh
111+
TAG_COMMIT=$(gh api repos/opentdf/platform/git/ref/tags/$LATEST_TAG --jq '.object.sha')
112+
jq --arg tag "$LATEST_TAG" '.["tag"] = $tag' lib/platform-proto-version.json > lib/platform-proto-version.tmp.json
113+
jq --arg commit "$TAG_COMMIT" '.["commit"] = $commit' lib/platform-proto-version.tmp.json > lib/platform-proto-version.json
114+
rm lib/platform-proto-version.tmp.json
115+
# Check for changes after regeneration
116+
if [ -z "$(git status --porcelain)" ]; then
117+
echo "No changes detected after regeneration."
118+
else
119+
echo "Changes detected after regeneration"
120+
echo "changes=true" >> "$GITHUB_OUTPUT"
121+
fi
122+
env:
123+
PLATFORM_SRC: ../platform/service
124+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
125+
126+
- name: Create new branch
127+
working-directory: ./web-sdk
128+
if: steps.check-pr.outputs.EXISTING_PR == '' && steps.update-platform-protos.outputs.changes == 'true'
129+
run: |
130+
git checkout -b $BRANCH_NAME
131+
git push origin $BRANCH_NAME
132+
env:
133+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
134+
BRANCH_NAME: update-platform-protos
135+
136+
- name: Update files
137+
working-directory: ./web-sdk
138+
if: steps.update-platform-protos.outputs.changes == 'true'
139+
run: |
140+
echo "Committing changes..."
141+
FILES_CHANGED=$(git status --porcelain | awk '{print $2}')
142+
for file in $FILES_CHANGED; do
143+
echo "Committing file: $file"
144+
145+
CONTENT=$(base64 -i $file)
146+
FILENAME=$(basename $file)
147+
MESSAGE="Update $FILENAME to match platform tag $LATEST_TAG"
148+
149+
SHA=$( git rev-parse $BRANCH_NAME:$file 2>/dev/null | grep -E '^[0-9a-f]{40}$' || echo "" )
150+
if [ -z "$SHA" ]; then
151+
SHA=""
152+
fi
153+
154+
gh api --method PUT /repos/opentdf/web-sdk/contents/$file \
155+
--field message="$MESSAGE" \
156+
--field content="$CONTENT" \
157+
--field encoding="base64" \
158+
--field branch="$BRANCH_NAME" \
159+
--field sha="$SHA"
160+
done
161+
env:
162+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
163+
BRANCH_NAME: update-platform-protos
164+
165+
- name: Create New PR
166+
working-directory: ./web-sdk
167+
if: steps.check-pr.outputs.EXISTING_PR == '' && steps.update-platform-protos.outputs.changes == 'true'
168+
env:
169+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
170+
run: |
171+
RELEASE_NOTES=$(gh release view $LATEST_TAG --repo opentdf/platform --json body --jq '.body')
172+
cat <<EOF > pr_body.txt
173+
This PR regenerates the platform pb files based on tag: $LATEST_TAG. It also updates the lib/platform-proto-version.json file to reflect the new tag and commit.
174+
175+
See the release: https://github.com/opentdf/platform/releases/tag/$LATEST_TAG
176+
177+
Release Notes:
178+
$RELEASE_NOTES
179+
EOF
180+
gh pr create \
181+
--title "fix(sdk): Updates to proto version $LATEST_TAG" \
182+
--body-file pr_body.txt \
183+
--head update-platform-protos \
184+
--base main
185+

‎lib/platform-proto-version.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"tag": "",
3+
"commit": ""
4+
}

‎scripts/platform.sh‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,22 @@
22

33
set -eu
44

5-
# Fetch latest platform code
5+
66
rm -rf platform lib/src/platform
7-
git clone https://github.com/opentdf/platform.git
7+
8+
if [ -n "${PLATFORM_SRC:-}" ]; then
9+
# Use PLATFORM_SRC for buf generate
10+
echo "Using PLATFORM_SRC: $PLATFORM_SRC"
11+
else
12+
# Clone latest platform code
13+
git clone https://github.com/opentdf/platform.git
14+
PLATFORM_SRC="platform/service"
15+
fi
816

917
# Generate Typescript code
1018
cd lib
1119
# version
1220
PATH="$PWD/node_modules/.bin:$PATH" buf --version
1321
# Ensure we use the local protoc-gen-es from node_modules
14-
PATH="$PWD/node_modules/.bin:$PATH" buf generate ../platform/service
15-
echo "Generated Typescript code from Protobuf files (src: platform/service, dst: lib/src/platform)"
22+
PATH="$PWD/node_modules/.bin:$PATH" buf generate "../$PLATFORM_SRC"
23+
echo "Generated Typescript code from Protobuf files (src: $PLATFORM_SRC, dst: lib/src/platform)"

0 commit comments

Comments
 (0)