Skip to content

docs: Documentation analysis and improvement#766

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
docs-issue-765-security-labels-94e5a4416bdc4121
Draft

docs: Documentation analysis and improvement#766
github-actions[bot] wants to merge 1 commit intomainfrom
docs-issue-765-security-labels-94e5a4416bdc4121

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 2, 2026

Closes #765

Summary of files analyzed

  • docs/workflows/security-scanning-ruleset.md
  • docs/workflows/gh-aw-security-detector.md
  • scripts/create-security-issues.sh

Issues found

  • docs/workflows/security-scanning-ruleset.md: The Severity Levels table documented oblt-aw/severity/* labels as if emitted by detector output, but current runtime issue creation does not apply those labels.
  • docs/workflows/security-scanning-ruleset.md and docs/workflows/gh-aw-security-detector.md: Label behavior was not fully synchronized, which could mislead readers about detector-created issue labels.

Changes made

  • Updated docs/workflows/security-scanning-ruleset.md Severity Levels table to reflect the current emitted label contract (oblt-aw/detector/security) for detector-created issues, to match observed runtime behavior.
  • Added an explicit note in docs/workflows/security-scanning-ruleset.md clarifying that oblt-aw/severity/* labels are not currently emitted and that severity is represented in finding entries.
  • Updated docs/workflows/gh-aw-security-detector.md usage section to explicitly state that oblt-aw/severity/* labels are not emitted and to cross-link severity interpretation to security-scanning-ruleset.md#severity-levels.
  • Preserved rule severity semantics while correcting label-contract documentation, so readers can still use severity levels without expecting non-existent issue labels.

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

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

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] Align security ruleset severity labels with detector issue output

0 participants