fix(doc-healer): gate artifact constant check on actual artifact production#44134
Merged
Conversation
…tant check Before treating a missing artifacts.md entry as a documentation gap, the healer now verifies the artifact is actually produced by checking: 1. Whether the artifact name appears in upload-artifact steps in any .github/workflows/*.lock.yml file or in pkg/workflow/js/ helpers 2. Whether the job builder is not a no-op stub (return nil, nil) Forward-declared constants like EvalsArtifactName (whose buildEvalsJob returns nil) are now skipped rather than incorrectly flagged as gaps. Closes #44133 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix artifact constant check to verify actual artifact production
fix(doc-healer): gate artifact constant check on actual artifact production
Jul 8, 2026
Contributor
🤖 PR Triage
Rationale: Draft. Small fix (17+/2−) for doc-healer false-positive flagging forward-declared constants for nil-returning builders. Low-risk. Promote when draft resolved and CI runs. Run §28909358158
|
This was referenced Jul 8, 2026
pelikhan
marked this pull request as ready for review
July 8, 2026 01:45
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Daily Documentation Healer workflow instructions to avoid treating forward-declared / unimplemented artifact constants as documentation drift, and recompiles the generated lock workflow to match.
Changes:
- Adds a “production confirmation” gate to the Step 2 artifact-constant check (lock workflow + JS helper presence, plus “not a no-op builder” check).
- Updates the compiled
.lock.ymlto reflect the markdown workflow change.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/daily-doc-healer.md |
Refines artifact constant gap-check instructions by gating on actual artifact production and implemented job builders. |
.github/workflows/daily-doc-healer.lock.yml |
Recompiled generated workflow reflecting the updated markdown instructions. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Low
Comment on lines
+163
to
+164
| grep -rn "name: <artifact-value>" .github/workflows/*.lock.yml | ||
| grep -rn '"<artifact-value>"' pkg/workflow/js/ |
| grep -rn '"<artifact-value>"' pkg/workflow/js/ | ||
| ``` | ||
|
|
||
| An artifact is **produced** if its name appears in the `name:` field of an `actions/upload-artifact` step in any generated `.github/workflows/*.lock.yml` file, or in the JS upload helpers under `pkg/workflow/js/`. |
This was referenced Jul 8, 2026
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
The doc-healer's Step 2 artifact constant check flagged any
ArtifactName = "..."constant missing fromartifacts.mdas a documentation gap — including forward-declared constants for unimplemented features (e.g.EvalsArtifactName = "evals", whosebuildEvalsJobreturnsnil, nil).Changes
.github/workflows/daily-doc-healer.md— Refines Step 2 artifact constant check to require production confirmation before treating a missingartifacts.mdentry as a gap:name:field of anactions/upload-artifactstep in any.github/workflows/*.lock.yml, or inpkg/workflow/js/upload helpersreturn nil, nil+ TODO).github/workflows/daily-doc-healer.lock.yml— Recompiled from updated markdownProduction check (added to Step 2)
Only constants whose artifact name appears in those outputs — and whose job builder is implemented — are eligible to be flagged as documentation gaps.