Skip to content

ci(apidocs): Refresh the API exceptions baseline daily - #131879

Open
akhilp117 wants to merge 6 commits into
masterfrom
akhilpindiprolu/eng-9066-keep-exceptionsjson-up-to-date-in
Open

akhilp117 wants to merge 6 commits into
masterfrom
akhilpindiprolu/eng-9066-keep-exceptionsjson-up-to-date-in

Conversation

@akhilp117

@akhilp117 akhilp117 commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Linear issue

our currentexceptions.json is a snapshot from when it was first generated (so Nov 19th), so it goes stale as people fix violations, add new ones, or move endpoints between teams. This PR adds a daily workflow that refreshes it from main and opens a bot PR when something actually changed so that the report card stays accurate without anyone running the commands by hand

I maderefresh-api-baseline.yml run daily at 09:00 UTC, and can also be run by hand from the Actions tab. It has two jobs which follow the same pattern as prune-oxlint-suppressions.yml:

  • scan runs make api-owner-map and make api-baseline ARGS="--update" with read-only access, and uploads the new exceptions.json as an artifact. --update keeps any reviewed status/reason values so that a refresh never wipes them
  • publish is the only job with the bot token. It runs publish-api-baseline.sh, which checks the artifact looks like an exceptions file, and compares only the entries with master's copy. generated and commit change on every run, so comparing the whole file would open a PR every day. If the entries changed it force-pushes bot/update-api-baseline and opens a PR if one isn't already open

The workflow also runs on PRs that change it or its script, but only scan runs there. I made it like this so that changes to it get tested before they merge (that's what ran on this PR)

@akhilp117
akhilp117 requested review from a team as code owners November 19, 2026 20:10
@linear-code

linear-code Bot commented Nov 19, 2026

Copy link
Copy Markdown

ENG-9066

@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Nov 19, 2026

@DominikB2014 DominikB2014 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! Mostly nits but some genuine good practices. I would also see if there's anyone on dev infra to take a quick look

…f shell

Replace publish-api-baseline.sh with a TypeScript module run by
actions/github-script. It commits through the Git Data API, so the job needs
no git identity, jq, or gh, and GitHub signs the bot's commit.

Co-Authored-By: Joshua Li <14209781+joshuarli@users.noreply.github.com>
@github-actions github-actions Bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Nov 20, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚨 Warning: This pull request contains Frontend and Backend changes!

It's discouraged to make changes to Sentry's Frontend and Backend in a single pull request. The Frontend and Backend are not atomically deployed. If the changes are interdependent of each other, they must be separated into two pull requests and be made forward or backwards compatible, such that the Backend or Frontend can be safely deployed independently.

Have questions? Please ask in the #discuss-dev-infra channel.

This branch was successfully deployed

1 active (outdated) deployment
Preview — 30318e30 Deployed Nov 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components Scope: Frontend Automatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants