Add AI-powered release notes reviewer GitHub Action#23174
Open
ebembi-crdb wants to merge 1 commit intomainfrom
Open
Add AI-powered release notes reviewer GitHub Action#23174ebembi-crdb wants to merge 1 commit intomainfrom
ebembi-crdb wants to merge 1 commit intomainfrom
Conversation
Introduces a GitHub Action that automatically reviews PRs touching release notes files using schema validation, technical accuracy checks, and OpenAI GPT-4o content quality analysis. - Copies core reviewer logic into .github/scripts/release_review/ - Adds standalone runner script (.github/scripts/run_release_review.py) - Adds workflow that triggers on PRs to main touching releases.yml or _includes/releases/** - Posts results as a neutral (advisory) check run and updatable PR comment - Never blocks merge; requires OPENAI_API_KEY repository secret
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Deploy Preview for cockroachdb-docs canceled.
|
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
1 participant
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
releases.ymlor_includes/releases/**)cockroach-education-ai-initiativesinto.github/scripts/release_review/— no running service requiredSetup required
Add
OPENAI_API_KEYas a repository secret: Settings → Secrets and variables → Actions → New repository secretGITHUB_TOKENis provided automatically with thepull-requests: writeandchecks: writepermissions declared in the workflow.Test plan
mainthat modifiessrc/current/_data/releases.ymlor a file undersrc/current/_includes/releases/and confirm the "Release Notes AI Review" workflow appears in the Checks tab<!-- docs-fast-agent-comment -->markerneutralconclusion (not blocking)