Skip to content

docs: Documentation analysis and improvement#1017

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs-issue-1016-ingress-secret-d79a9f884f148c99
Draft

docs: Documentation analysis and improvement#1017
github-actions[bot] wants to merge 1 commit into
mainfrom
docs-issue-1016-ingress-secret-d79a9f884f148c99

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Closes #1016

Summary of files analyzed

  • .github/workflows/oblt-aw-ingress.yml
  • docs/workflows/oblt-aw-ingress.md
  • package.json (to determine available repo checks)

Issues found

  • docs/workflows/oblt-aw-ingress.md: API / Interface section listed only COPILOT_GITHUB_TOKEN, but ingress workflow_call declares both COPILOT_GITHUB_TOKEN and BUILDKITE_API_TOKEN.
  • docs/workflows/oblt-aw-ingress.md: Prerequisites section implied a single optional secret and did not reflect route-specific Buildkite token usage.
  • docs/workflows/oblt-aw-ingress.md: Minimal example remained valid, but lacked a note clarifying when BUILDKITE_API_TOKEN should be mapped.

Changes made

  • Updated Prerequisites in docs/workflows/oblt-aw-ingress.md to list both optional secrets and clarify that BUILDKITE_API_TOKEN is route-specific to estc-pr-buildkite-detective.
  • Updated API / Interface in docs/workflows/oblt-aw-ingress.md to include BUILDKITE_API_TOKEN with required: false, matching .github/workflows/oblt-aw-ingress.yml.
  • Added an example note in docs/workflows/oblt-aw-ingress.md clarifying when to map BUILDKITE_API_TOKEN (commonly from BUILDKITE_LOGS_API_TOKEN) so minimal usage remains accurate while documenting route-specific requirements.

What is this? | From workflow: Observability Agentic Workflow Entrypoint

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[oblt-aw][autodoc] Document BUILDKITE_API_TOKEN in oblt-aw-ingress interface docs

0 participants