Split out Elastic-specific workflows with estc- prefix#431
Conversation
… section in docs Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
estc- prefix
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: CHILL Plan: Pro 📒 Files selected for processing (17)
📝 WalkthroughWalkthroughRenames many GitHub Actions workflows, lockfiles, examples, and docs to use "estc" / "(Elastic-specific)" variants; updates references, example workflows, mkdocs navigation, and dogfooding exclusions. Changes are textual/identifier updates; no control-flow or behavioral changes were introduced. Changes
Sequence Diagram(s)(omitted — changes are renames/string updates and do not introduce new multi-component control flow) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/ai |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
.github/workflows/gh-aw-estc-pr-buildkite-detective.lock.yml (1)
134-134:⚠️ Potential issue | 🟠 MajorStale workflow file reference may cause runtime failure.
GH_AW_WORKFLOW_FILEstill references"gh-aw-pr-buildkite-detective.lock.yml"(the old filename withoutestc-prefix), but this file has been renamed togh-aw-estc-pr-buildkite-detective.lock.yml. The timestamp check step may fail because it's looking for a non-existent file.Since this is an auto-generated
.lock.ymlfile, the fix must be applied to the corresponding source.mdfile and recompiled withgh aw compile.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/gh-aw-estc-pr-buildkite-detective.lock.yml at line 134, Update the source .md that generates the auto-generated lock file so the GH_AW_WORKFLOW_FILE variable uses the new filename "gh-aw-estc-pr-buildkite-detective.lock.yml" instead of the old "gh-aw-pr-buildkite-detective.lock.yml", then re-run the generator with "gh aw compile" so the .lock.yml is regenerated with the correct GH_AW_WORKFLOW_FILE value; look for the variable named GH_AW_WORKFLOW_FILE in the template/source that produces the .lock.yml to make this change..github/workflows/gh-aw-estc-docs-patrol-external.lock.yml (1)
134-135:⚠️ Potential issue | 🟠 MajorStale workflow file reference may cause runtime failure.
GH_AW_WORKFLOW_FILEstill references"gh-aw-docs-patrol-external.lock.yml"(the old filename withoutestc-prefix), but this file has been renamed togh-aw-estc-docs-patrol-external.lock.yml. The timestamp check step may fail because it's looking for a non-existent file.Since this is an auto-generated
.lock.ymlfile, the fix must be applied to the corresponding source.mdfile and recompiled withgh aw compile.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/gh-aw-estc-docs-patrol-external.lock.yml around lines 134 - 135, Update the GH_AW_WORKFLOW_FILE env var so it points to the renamed workflow file: replace the old value "gh-aw-docs-patrol-external.lock.yml" with "gh-aw-estc-docs-patrol-external.lock.yml" by editing the source .md that generates this .lock.yml (do not edit the generated .lock.yml directly), then recompile the workflow using the command `gh aw compile` so the change is propagated into the generated GH Actions workflow; look for the env block that sets GH_AW_WORKFLOW_FILE in the generated file to confirm the updated value..github/workflows/gh-aw-estc-downstream-health.lock.yml (1)
127-130:⚠️ Potential issue | 🔴 CriticalRename is incomplete: timestamp check still references the old lock filename.
At Line 129,
GH_AW_WORKFLOW_FILEis stillgh-aw-downstream-health.lock.yml, but this workflow now runs fromgh-aw-estc-downstream-health.lock.yml. This can make the timestamp validation step check the wrong file (or fail), causing incorrect workflow health behavior.Suggested fix
- GH_AW_WORKFLOW_FILE: "gh-aw-downstream-health.lock.yml" + GH_AW_WORKFLOW_FILE: "gh-aw-estc-downstream-health.lock.yml"Then regenerate this
.lock.ymlfrom its source.md.Based on learnings: In this repository,
.lock.ymlfiles are auto-generated bygh aw compile; changes must be made in the source.mdand then recompiled.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/gh-aw-estc-downstream-health.lock.yml around lines 127 - 130, The env variable GH_AW_WORKFLOW_FILE still points to "gh-aw-downstream-health.lock.yml" but this workflow file is now "gh-aw-estc-downstream-health.lock.yml", so update the GH_AW_WORKFLOW_FILE value to "gh-aw-estc-downstream-health.lock.yml" where it’s defined (the actions/github-script step) so the timestamp validation checks the correct lock file, then regenerate this .lock.yml from its source .md using the repository’s gh aw compile flow to ensure the change is persisted and consistent with the auto-generated workflow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In @.github/workflows/gh-aw-estc-docs-patrol-external.lock.yml:
- Around line 134-135: Update the GH_AW_WORKFLOW_FILE env var so it points to
the renamed workflow file: replace the old value
"gh-aw-docs-patrol-external.lock.yml" with
"gh-aw-estc-docs-patrol-external.lock.yml" by editing the source .md that
generates this .lock.yml (do not edit the generated .lock.yml directly), then
recompile the workflow using the command `gh aw compile` so the change is
propagated into the generated GH Actions workflow; look for the env block that
sets GH_AW_WORKFLOW_FILE in the generated file to confirm the updated value.
In @.github/workflows/gh-aw-estc-downstream-health.lock.yml:
- Around line 127-130: The env variable GH_AW_WORKFLOW_FILE still points to
"gh-aw-downstream-health.lock.yml" but this workflow file is now
"gh-aw-estc-downstream-health.lock.yml", so update the GH_AW_WORKFLOW_FILE value
to "gh-aw-estc-downstream-health.lock.yml" where it’s defined (the
actions/github-script step) so the timestamp validation checks the correct lock
file, then regenerate this .lock.yml from its source .md using the repository’s
gh aw compile flow to ensure the change is persisted and consistent with the
auto-generated workflow.
In @.github/workflows/gh-aw-estc-pr-buildkite-detective.lock.yml:
- Line 134: Update the source .md that generates the auto-generated lock file so
the GH_AW_WORKFLOW_FILE variable uses the new filename
"gh-aw-estc-pr-buildkite-detective.lock.yml" instead of the old
"gh-aw-pr-buildkite-detective.lock.yml", then re-run the generator with "gh aw
compile" so the .lock.yml is regenerated with the correct GH_AW_WORKFLOW_FILE
value; look for the variable named GH_AW_WORKFLOW_FILE in the template/source
that produces the .lock.yml to make this change.
ℹ️ Review info
Configuration used: Repository UI (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (35)
.github/workflows/gh-aw-estc-docs-patrol-external.lock.yml.github/workflows/gh-aw-estc-docs-patrol-external.md.github/workflows/gh-aw-estc-docs-pr-review.lock.yml.github/workflows/gh-aw-estc-docs-pr-review.md.github/workflows/gh-aw-estc-downstream-health.lock.yml.github/workflows/gh-aw-estc-downstream-health.md.github/workflows/gh-aw-estc-newbie-contributor-patrol-external.lock.yml.github/workflows/gh-aw-estc-newbie-contributor-patrol-external.md.github/workflows/gh-aw-estc-pr-buildkite-detective.lock.yml.github/workflows/gh-aw-estc-pr-buildkite-detective.md.github/workflows/smoke-test-install.yml.github/workflows/trigger-estc-docs-pr-review.yml.github/workflows/trigger-estc-downstream-health.yml.github/workflows/trigger-estc-pr-buildkite-detective.ymldocs/blog/posts/meet-the-detectives.mddocs/blog/posts/meet-the-docs-patrol.mddocs/blog/posts/meet-the-reviewers.mddocs/blog/posts/meet-the-watchdogs.mddocs/workflows/gh-agent-workflows.mddocs/workflows/gh-agent-workflows/docs-patrol-overview.mddocs/workflows/gh-agent-workflows/newbie-contributor.mdgh-agent-workflows/README.mdgh-agent-workflows/estc-docs-patrol-external/README.mdgh-agent-workflows/estc-docs-patrol-external/example.ymlgh-agent-workflows/estc-docs-pr-review/README.mdgh-agent-workflows/estc-docs-pr-review/dogfood-with.ymlgh-agent-workflows/estc-docs-pr-review/example.ymlgh-agent-workflows/estc-downstream-health/README.mdgh-agent-workflows/estc-downstream-health/example.ymlgh-agent-workflows/estc-newbie-contributor-patrol-external/README.mdgh-agent-workflows/estc-newbie-contributor-patrol-external/example.ymlgh-agent-workflows/estc-pr-buildkite-detective/README.mdgh-agent-workflows/estc-pr-buildkite-detective/example.ymlmkdocs.ymlscripts/dogfood.sh
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
❌ Author of the following commits did not sign a Contributor Agreement: Please, read and sign the above mentioned agreement if you want to contribute to this project |
|
/ai i dont think estc-pr-buildkite-detective is elastic specific just because an input defaults to |
|
Good catch — after re-checking each workflow, Why each was marked:
For So I agree with your concern: this one should likely stay generic unless we add truly Elastic-only behavior. What is this? | From workflow: Mention in PR Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
Several workflows are only useful within Elastic (they reference
elastic.co/docs, Elastic style andapplies_toconventions, Buildkite CI, or Elastic-owned downstream repositories). This PR makes those workflows explicitly Elastic-specific in both naming and docs.Changes
Renamed workflows with
estc-prefixdocs-patrol-external→estc-docs-patrol-externalnewbie-contributor-patrol-external→estc-newbie-contributor-patrol-externaldocs-pr-review→estc-docs-pr-reviewdownstream-health→estc-downstream-healthpr-buildkite-detective→estc-pr-buildkite-detectiveDocumentation updates
docs/workflows/gh-agent-workflows.mdgh-agent-workflows/README.mdmkdocs.ymlnavigation to groupestc-workflows under an Elastic-specific section.Associated rename/reference updates
Updated compiled workflow files (
.lock.yml) and source workflow files (.md) for each renamed workflow.Renamed matching trigger workflows for:
estc-docs-pr-reviewestc-downstream-healthestc-pr-buildkite-detectiveUpdated related references in per-workflow
README.md/example.ymlfiles, smoke-test install workflow, dogfood exclusions, docs overview pages, and blog links.Fixes Split out Elastic specific workflows #428
Summary by CodeRabbit
Documentation
Chores