Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Document additional automation of API docs build #607

Merged
merged 1 commit into from
Jun 16, 2022
Merged

Document additional automation of API docs build #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/docs/api/public.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,9 @@ The openapi-diff test will fail when CI runs on your pull request, this is expec

Once you make changes to an endpoint and merge the change into Sentry, a series of GitHub Actions will be triggered to make your changes automatically go live:

1. The `openapi / deref_json` GitHub Action in [sentry](https://github.com/getsentry/Sentry) will update the schema in [sentry-api-schema](https://github.com/getsentry/sentry-api-schema) with the OpenAPI build artifact.
2. Once [sentry-api-schema](https://github.com/getsentry/sentry-api-schema) is updated, in a local copy of [sentry-docs](https://github.com/getsentry/sentry-docs) run `./scripts/bump-api-schema-sha.sh` to update the `SENTRY_API_SCHEMA_SHA` with the latest.
3. Finally, merge your docs change so a build is triggered in [sentry-docs](https://github.com/getsentry/sentry-docs).
1. The [`openapi` workflow in `sentry`](https://github.com/getsentry/sentry/blob/master/.github/workflows/openapi.yml) updates the schema in [sentry-api-schema](https://github.com/getsentry/sentry-api-schema) with the OpenAPI build artifact.
2. The [`cascade-to-sentry-docs` workflow in `sentry-api-schema`](https://github.com/getsentry/sentry-api-schema/blob/main/.github/workflows/cascade-to-sentry-docs.yml) reacts to the push to `main` by triggering the [`bump-api-schema-sha` workflow in `sentry-docs`](https://github.com/getsentry/sentry-docs/blob/master/.github/workflows/bump-api-schema-sha.yml).
3. The [`bump-api-schema-sha` workflow in `sentry-docs`](https://github.com/getsentry/sentry-docs/blob/master/.github/workflows/bump-api-schema-sha.yml) fetches the latest commit SHA from `sentry-api-schema` and writes it into the correct file, then makes and merges a PR, which kicks off a deploy of `sentry-docs` via Vercel to https://docs.sentry.io/.

### Requesting an API to be public

Expand Down