docs: update consumer examples to @v3 + Bedrock (no API key) + structured prompts - #57
Merged
Merged
Conversation
…e structured prompt, drop ANTHROPIC_API_KEY
… IaC review prompt, drop ANTHROPIC_API_KEY
…allout pointing at examples
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
🤖 Bedrock Review —
|
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
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.
What
Brings the ai-workflows consumer examples (and the README's stale snippets) up to the current v3 standard, and backports the terse structured review prompt that's been proven in
dotCMS/core.Examples (the canonical copy-paste artifacts)
Both
examples/consumer-repo-workflow.ymlandexamples/infrastructure-consumer-workflow.yml:@v3(was@v2.0.0) so consumers track patch releases automaticallymodel_id: ${{ vars.BEDROCK_MODEL_ID }}+bedrock_role_arn: ${{ vars.BEDROCK_ROLE_ARN }}ANTHROPIC_API_KEYsecrets blocks — reviews run on Bedrock via the IAM role; the key is vestigialfile:line, no essays (mirrorscore's.github/prompts/gpt-auto-review.md). The infra example uses the IaC-flavored variant (bugs / security / state & blast radius / cost / IaC conventions).${{ vars.AI_REVIEW_MODEL_ID || vars.BEDROCK_MODEL_ID }}.README
@v1.0.0/@v2.0.0→@v3@v3, noANTHROPIC_API_KEYrequired, examples are canonicalWhy
The examples are what consuming repos copy. They were 2 majors behind (old
@v1/@v2,allowed_tools/direct_promptinput names, required API key) whilecore/platform/IaC moved to@v3+ Bedrock-via-role + structured prompts. This closes that gap so new consumers start on the current pattern.Follow-up (not in this PR)
The README still has ~15 stale references in its prose, inputs table, and inline snippets (
direct_prompt/allowed_toolsmulti-line blocks that can't be safely sed-renamed). Left for a focused doc-rewrite rather than half-editing it into broken YAML — the examples are now the authoritative reference.