Skip to content

Commit 386635a

Browse files
docs(bots): reconcile design-doc engine SHA + flag the 4-way pin lockstep
Review follow-up (F2): the workflows pin engine d24ca21 but the design doc still said b6205fb, so a reviewer couldn't confirm which engine is installed. - Update the design doc's operative "Pinned to" line to d24ca21 (post-#107, issue-Type flow selection), noting the earlier b6205fb draft. - Add a comment at each of the four engine-ref pin sites noting the SHA is duplicated across all four bot workflows and must be bumped in lockstep. Co-authored-by: Isaac Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
1 parent 9c95d2f commit 386635a

5 files changed

Lines changed: 19 additions & 4 deletions

File tree

.github/workflows/engineer-bot-followup.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ jobs:
101101
with:
102102
app-id: ${{ secrets.ENGINEER_BOT_APP_ID }}
103103
private-key: ${{ secrets.ENGINEER_BOT_APP_PRIVATE_KEY }}
104+
# Pinned engine SHA. DUPLICATED in all four bot workflows
105+
# (engineer-bot{,-followup}.yml, reviewer-bot{,-followup}.yml) — bump
106+
# them in LOCKSTEP or the bots silently run different engine versions.
104107
engine-ref: d24ca2171d191a652a67f4f43995f0959c9a5791
105108

106109
# Run the follow-up. Inlines the engine's bot-run env contract for

.github/workflows/engineer-bot.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ jobs:
8989
with:
9090
app-id: ${{ secrets.ENGINEER_BOT_APP_ID }}
9191
private-key: ${{ secrets.ENGINEER_BOT_APP_PRIVATE_KEY }}
92+
# Pinned engine SHA. DUPLICATED in all four bot workflows
93+
# (engineer-bot{,-followup}.yml, reviewer-bot{,-followup}.yml) — bump
94+
# them in LOCKSTEP or the bots silently run different engine versions.
9295
engine-ref: d24ca2171d191a652a67f4f43995f0959c9a5791
9396

9497
- name: Resolve issue + gather context

.github/workflows/reviewer-bot-followup.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ jobs:
7777
with:
7878
app-id: ${{ secrets.REVIEW_BOT_APP_ID }}
7979
private-key: ${{ secrets.REVIEW_BOT_APP_PRIVATE_KEY }}
80+
# Pinned engine SHA. DUPLICATED in all four bot workflows
81+
# (engineer-bot{,-followup}.yml, reviewer-bot{,-followup}.yml) — bump
82+
# them in LOCKSTEP or the bots silently run different engine versions.
8083
engine-ref: d24ca2171d191a652a67f4f43995f0959c9a5791
8184

8285
- name: Run reviewer follow-up

.github/workflows/reviewer-bot.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ jobs:
8282
with:
8383
app-id: ${{ secrets.REVIEW_BOT_APP_ID }}
8484
private-key: ${{ secrets.REVIEW_BOT_APP_PRIVATE_KEY }}
85+
# Pinned engine SHA. DUPLICATED in all four bot workflows
86+
# (engineer-bot{,-followup}.yml, reviewer-bot{,-followup}.yml) — bump
87+
# them in LOCKSTEP or the bots silently run different engine versions.
8588
engine-ref: d24ca2171d191a652a67f4f43995f0959c9a5791
8689

8790
- name: Resolve trigger inputs

docs/superpowers/specs/2026-07-14-onboard-bot-engine-design.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,13 @@ databricks-bot-engine, adopting **both** bots and used to surface onboarding
194194
friction back to the engine.
195195

196196
### Reviewer — flipped to PAT-free App-auth
197-
Pinned to engine SHA `b6205fb502566d617a456ccf3c37f3e4e3072ccd` (post-#100). Both
198-
reviewer workflows now pass `engine-auth: app` and **drop `engine-pat`**: the
199-
reusable mints a short-lived, engine-scoped GitHub App installation token from
200-
the review-bot App creds it already receives. No `BOT_ENGINE_PAT` secret.
197+
Pinned to engine SHA `d24ca2171d191a652a67f4f43995f0959c9a5791` (post-#107, which
198+
selects the engineer author flow from the issue **Type** — Bug ⇒ bug-fix, Feature
199+
⇒ enhancement; earlier drafts pinned `b6205fb`, post-#100). Both reviewer
200+
workflows pass `engine-auth: app` and **drop `engine-pat`**: the reusable mints a
201+
short-lived, engine-scoped GitHub App installation token from the review-bot App
202+
creds it already receives. No `BOT_ENGINE_PAT` secret. The same SHA is pinned in
203+
all four bot workflows (bump them in lockstep).
201204

202205
### Engineer-bot — added (bug-fix flow)
203206
- `engineer-bot.yml` (author) + `engineer-bot-followup.yml` — own jobs (not

0 commit comments

Comments
 (0)