Skip to content

Drop should-comment-success / should-comment-failure outputs from evaluate-artifact - #3995

Open
Mpdreamz wants to merge 2 commits into
mainfrom
feature/changelog-drop-comment-outputs
Open

Drop should-comment-success / should-comment-failure outputs from evaluate-artifact#3995
Mpdreamz wants to merge 2 commits into
mainfrom
feature/changelog-drop-comment-outputs

Conversation

@Mpdreamz

@Mpdreamz Mpdreamz commented Sep 1, 2026

Copy link
Copy Markdown
Member

Removes the two step outputs should-comment-success and should-comment-failure from ChangelogArtifactEvaluationService now that changelog/submit/apply (docs-actions #324) no longer reads them.

Affects: Automation

Why

evaluate-artifact emitted two comment-gate outputs that submit/apply used to decide which JS comment script to run. Those three comment steps were replaced by the native changelog github-comment command in docs-actions #324, which reads the changelog-decision artifact directly — the outputs are now dead. Leaving them in place would mislead future readers into thinking something still consumes them.

What

Outputs removed from ChangelogArtifactEvaluationService

shouldCommentSuccess and shouldCommentFailure variables and their two SetOutputAsync calls are deleted. The surrounding log message is trimmed to remove the two fields. No other logic in the service changes; should-commit and all other outputs are unaffected.

Tests updated

Four test methods in ChangelogArtifactEvaluationServiceTests had assertions verifying the removed outputs. Each assertion is dropped and the method is renamed to reflect only what it still tests (SetsCommitFalse instead of SetsCommentSuccessFlag, etc.).

Verify

dotnet test tests/Elastic.Changelog.Tests/

Stack: 4 of 4, on top of docs-actions #324.

Risk: This PR must not merge before docs-actions #324. Removing the outputs while submit/apply still gates on them (if: steps.meta.outputs.should-comment-success == 'true') would silently prevent the comment steps from firing — elastic/cloud would lose PR comments with no visible error. Merge order is: docs-actions #324 first (or confirm it is already merged and the v1 tag updated), then this PR.

Out of scope: Renaming evaluate-artifact / prepare-artifact and their service types — that is its own PR with a wider call-site audit.

…luate-artifact

submit/apply no longer reads these outputs — PR 3 (docs-actions#324)
removed the three actions/github-script steps that gated on them and
replaced them with changelog github-comment running in the downstream
release-notes-comments workflow. Removing them here completes the
four-PR migration sequence.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

Docs preview (local build)

Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3995/

The CommentBody private record had no [JsonPropertyName] annotation, so
source-generated JSON emitted "Body" (PascalCase). GitHub's issues/comments
API requires lowercase "body" and returns 422 for an unrecognised key,
treating the payload as body-less.

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants