-
Notifications
You must be signed in to change notification settings - Fork 9
Add AI PR review workflow #290
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Mpdreamz
wants to merge
1
commit into
main
Choose a base branch
from
feature/pr-review
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: PR Review | ||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled] | ||
|
|
||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| copilot-requests: write | ||
| issues: read | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| run: | ||
| if: >- | ||
| github.event.pull_request.draft == false && | ||
| !contains(github.event.pull_request.labels.*.name, 'skip-auto-pr-review') | ||
| uses: elastic/ai-github-actions/.github/workflows/gh-aw-pr-review.lock.yml@v0 | ||
| with: | ||
| allowed-bot-users: "github-actions[bot],dependabot[bot]" | ||
| intensity: aggressive | ||
| minimum_severity: nitpick | ||
| additional-instructions: | | ||
| This is the elastic/docs-actions repo — a collection of reusable GitHub Actions | ||
| (composite actions) and AI-powered agentic workflows for Elastic documentation teams. | ||
|
|
||
| ## Two-file pattern for agentic workflows (critical) | ||
| Agentic workflow sources live in `.github/workflows/gh-aw-*.md` (human-editable). | ||
| Compiled outputs live in `.github/workflows/gh-aw-*.lock.yml` (generated via `make compile`). | ||
| NEVER suggest editing `.lock.yml` files directly — all edits go in the `.md` source, | ||
| then `make compile` regenerates the lock file. | ||
| Flag any PR that modifies a `.lock.yml` without a matching change to its `.md` source. | ||
|
|
||
| ## inlined-imports frontmatter | ||
| Reusable workflows consumed by other repos MUST have `inlined-imports: true` in their | ||
| frontmatter. Without it, runtime imports fail silently because callers lack access to | ||
| source fragments. Flag its absence on any cross-repo reusable workflow. | ||
|
|
||
| ## Permissions are load-bearing | ||
| All reusable agentic workflows need `copilot-requests: write`. Caller jobs need that | ||
| plus `discussions: write`. Missing permissions cause GitHub to reject the workflow at | ||
| runtime — do not suggest removing them as "cleanup." | ||
|
|
||
| ## Auth token | ||
| `COPILOT_GITHUB_TOKEN` is the standard auth mechanism across this repo. | ||
| Do not suggest swapping it for `GITHUB_TOKEN` or personal access tokens. | ||
|
|
||
| ## Changelog pipeline | ||
| The changelog actions form a multi-stage pipeline: | ||
| bundle-create → bundle-fetch → bundle-pr → bundle-upload → submit → upload → validate. | ||
| Changes to one stage may break downstream stages — flag cross-stage impact. | ||
| `changelog/submit` and `changelog/upload` push to production published release notes. | ||
|
|
||
| ## Trigger conditions | ||
| `if:` conditions on slash commands are intentional guards, not redundant filters. | ||
| Do not suggest removing them. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.