Repository navigation
ci(api-schema): Authenticate and validate the schema SHA before bumping - #20001
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
The bump job now fails when GitHub does not return a commit SHA. It does not write an error body into the schema pin. The plan checks API page errors, API page views, and client errors. An issue escalates when API page errors rise or API page views fall. Services: PlanWhat changedThe bump job authenticates the GitHub request for the latest API schema commit. It fails on HTTP errors. It rejects a value that is not a 40-character hex SHA. The job no longer writes an API error body into the schema pin. sentry-docs must receive this commit. The workflow file becomes live on the default branch. The Vercel site build does not read this workflow file. Page behavior does not change on this deploy. Deploy config maps the Vercel project to sentry-docs. RiskIf the new rules are too strict, the bump job fails. API reference pages then stop receiving schema updates. If the new rules are too weak, a non-SHA value can merge again. The production build then fails. API reference pages can go missing until a later good pin. The OpenAPI fetch runs at build time. A bad pin fails the build. Browser clients do not fetch that schema. The live site can stay on the last good deploy. Client errors may not rise in that case. Intended effectThis change has no queryable production effect. Site event data does not record GitHub Actions job results.
The executor needs the next Bump API Schema SHA run. That run must not merge a non-SHA pin. That job surface is not connected. See Not observable. Regression watchWatch the API reference path this pin feeds. Watch overall client errors on the same ship. A later bad pin fails the build. The live site can stay on the last good deploy. API page views falling is the miss users feel. Traces are sampled at 30%.
Not observableGitHub Actions Bump API Schema SHA success and fail-closed logs. Whether a merged schema pin is a 40-character hex SHA. Vercel production build failure on a later bad pin. Site telemetry can stay green on the last good deploy. Stale API reference content when the bump job stops. Freshness has no connected signal. |
DESCRIBE YOUR PR
The Bump API Schema SHA workflow got rate-limited by the GitHub API and wrote the error body (
{"message":"API rate limit exceeded for ..."}) intoSENTRY_API_SCHEMA_SHA. It then admin-merged the change (#19999). That brokemasterfor about 10 minutes, until the next run (#20000) replaced it with a real SHA.The workflow called the commits API without authentication and never checked what came back. It now:
sentry-api-schema, so the request gets the much higher authenticated rate limit.curl --fail, so an HTTP error fails the job instead of returning the error body.It also fixes
-sSlto-sSL. Lowercase-lis curl's FTP--list-onlyflag;-Lfollows redirects, which is what was meant.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via @sergical.
--
View Junior Session [Sentry]