review: document the Sentry OTLP secrets as a hard install prerequisite#254
Merged
Conversation
Follow-up to review feedback on #241: a consuming repo without GH_AW_OTEL_SENTRY_ENDPOINT / GH_AW_OTEL_SENTRY_AUTHORIZATION does not degrade gracefully. The compiled lock feeds the empty endpoint into the MCP gateway's OTLP config, whose schema requires a non-empty URL, and the agent job dies at startup (observed on the first run of #241). A graceful skip would need upstream gh-aw support; until then the fix is prose: list the two secrets in the README's required-secrets section and warn at the observability block itself, with the workaround (comment the block out in the installed review.md as a preserved local edit and recompile).
🦋 Changeset detectedLatest commit: 68a9fc3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
khan-actions-bot
requested review from
a team,
jaredly and
jeresig
and removed request for
a team
Contributor
Review Guidancegithub-actions (1 file)
Common patterns2 files: The same hard-required-secrets warning was added in both the README required-secrets section and the Excluded from review (1 file)Not individually reviewed — generated, formatting-only, or fully explained by a common pattern above:
Low-confidence advisory notes (2)
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
jeresig
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to reviewer feedback on #241 (comment): a consuming repo that installs the reviewer without the two Sentry OTLP secrets does not degrade gracefully. The compiled lock feeds the empty
GH_AW_OTEL_SENTRY_ENDPOINTinto the MCP gateway's OTLP config, whose schema requires a non-empty URL, so the agent job dies at startup with no useful pointer to the cause (observed on the first run of #241).A graceful skip-when-empty would need upstream gh-aw support; until then the fix is documentation:
workflows/review/README.md:GH_AW_OTEL_SENTRY_ENDPOINTandGH_AW_OTEL_SENTRY_AUTHORIZATIONadded to the "Required secrets / variables" section, with the failure mode and the workaround (comment out theobservability:block in the installedreview.mdas a local edit, whichgh aw updatepreserves, and recompile).workflows/review/review.md: the same warning added to the comment on theobservability:block itself, where an installer actually encounters it.Changeset included (patch; prose only, no behavior change).
Testing
vitestsuite passes;version-sync.test.tsin particular (no version literals added toreview.md).