docs: Documentation analysis and improvement#1026
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Closes #1025
Summary of files analyzed
.github/workflows/oblt-aw-ingress.yml.github/workflows/gh-aw-estc-pr-buildkite-detective.yml.github/remote-workflow-template/obs/.github/workflows/oblt-aw.ymldocs/workflows/oblt-aw-client-template.mddocs/workflows/gh-aw-estc-pr-buildkite-detective.mddocs/workflows/oblt-aw-ingress.mdIssues found
docs/workflows/oblt-aw-client-template.md: stated ingress skips Buildkite detective when the secret is absent..github/workflows/oblt-aw-ingress.yml: routing condition forestc-pr-buildkite-detectiveis based on failed Buildkite status context and dashboard gate only; no secret-presence check is part of routing..github/workflows/gh-aw-estc-pr-buildkite-detective.yml:workflow_callrequiresBUILDKITE_API_TOKEN, so missing secret mapping causes contract failure.Changes made
docs/workflows/oblt-aw-client-template.md: replaced the inaccurate “ingress skips the job when absent” claim with explicit required-secret behavior for failed Buildkite status events.docs/workflows/gh-aw-estc-pr-buildkite-detective.md: added explicit note that ingress routing does not validate secret presence and that missingBUILDKITE_LOGS_API_TOKENmapping prevents the requiredworkflow_callsecret contract from being satisfied.What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.