Skip to content

Conversation

@brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Dec 24, 2025

This change adds a single line fix to our .github/workflows/codeowner_review_status.yml check.

The Documentation team has noticed flaky failures in the required check on PRs we've already approved. It wasn't clear why this was happening or how to reproduce consistently. @joepeeples and I were able to uncover that this occurs when you comment on an already approved PR.

When you comment on a PR, that changes the review.state to COMMENTED. So the check runs again, doesn't see it's approved, and fails.

Testing

Steps to reproduce:

  1. Approve a PR with suggested changes.
  2. Reply to your comment that contains the suggested change.
  3. Notice that the approval check re-runs and fails, because the status is now "COMMENTED" instead of "APPROVED".

We tested this in two branches: one contains the fix and the other doesn't. As you can see, when the fix is applied, the check passes as expected. When the fix is not applied, the check fails.

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

State tracking logic breaks when a reviewer adds a comment after an approval
@brett0000FF brett0000FF added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 24, 2025
@brett0000FF brett0000FF requested a review from a team as a code owner December 24, 2025 16:52
@github-actions github-actions bot added the Github Related to Github configurations label Dec 24, 2025
@brett0000FF brett0000FF removed the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Github Related to Github configurations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants