Skip to content

[doc-healer] DDUw improvement: scan pkg/constants for new artifact name constants and verify artifacts.md coverage #25813

@github-actions

Description

@github-actions

Background

Issue #25683 ("Doc: firewall-audit-logs artifact name not documented for downstream consumers") was filed on 2026-04-10 and closed the same day when PR #25684 created docs/src/content/docs/reference/artifacts.md. DDUw had not proactively detected or documented this gap before the issue was filed, even though the FirewallAuditArtifactName constant had existed in pkg/constants/constants.go for some time.

Separately, DDUw's Step 1c currently only checks for [docs]-prefixed DDUw PRs to determine whether a closed issue was addressed. PR #25684 — the fix — was NOT a DDUw PR, so Step 1c would mark issue #25683 as still "unaddressed" on subsequent runs, causing repeated re-examination that ends in a (correct) noop rather than a clean skip.

Gap 1 — No scan of pkg/constants/ for undocumented artifact constants

Which DDUw step failed: Step 2 ("Analyze Changes"). DDUw scans merged PRs and commits for new features but does not specifically look at additions to pkg/constants/constants.go or pkg/constants/job_constants.go for new *ArtifactName constants.

Concrete wording to add to DDUw Step 2:

Artifact constant check: After reviewing recent commits, run:

grep -n "ArtifactName\s*=" pkg/constants/constants.go pkg/constants/job_constants.go

For each constant found, verify that the artifact name value is listed in docs/src/content/docs/reference/artifacts.md. If a constant is missing from the reference page, treat it as a documentation gap and add it.

Gap 2 — Step 1c only recognizes DDUw-created [docs] PRs as "addressed"

Which DDUw step failed: Step 1c ("Scan Recently Closed Documentation Issues").

Current behavior: Step 1c checks whether a PR with label documentation automation and title prefix [docs] references the issue. This misses non-DDUw PRs (like PR #25684) that legitimately close documentation issues.

Concrete wording to add to DDUw Step 1c (after the existing [docs] PR check):

If no DDUw [docs] PR references the issue, also search for any merged PR that closes or fixes the issue by number (e.g. closes #NNN, fixes #NNN, resolves #NNN in the PR body). If such a PR is found, verify the documentation change it made is complete and skip the issue.

Expected outcome

Related

Note

🔒 Integrity filter blocked 1 item

The following item were blocked because they don't meet the GitHub integrity level.

  • #20207 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Daily Documentation Healer · ● 328.7K ·

  • expires on Apr 14, 2026, 1:25 PM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions