feat: add revision guard draft conversion flow by NssGourav · Pull Request #2279 · hiero-ledger/hiero-sdk-python

NssGourav · 2026-05-13T19:22:20Z

Description:

Implement the first event-driven Revision Guard slice for the Python SDK review flow.

This PR handles the CHANGES_REQUESTED path by converting a ready PR back to draft and cleaning up managed review/queue labels, while keeping the implementation lightweight and flexible around evolving label logic.

Add a revision-guard review-event workflow for pull_request_review.submitted
Convert PRs to draft when a review is submitted with changes_requested
Remove managed review/queue labels during that transition
Keep managed-label handling configurable instead of hardcoding current label behavior
Add focused tests for bot-authored PRs, already draft PRs, managed-label cleanup, and configurable labels

Related issue(s):

Part of #2264

Notes for reviewer:

This PR intentionally covers only the event-driven draft-conversion slice of Revision Guard.

It does not include the broader cron side requirements checklist/reporting work. The scope here is limited to the minimal to the aligned direction:

CHANGES_REQUESTED -> draft
managed label cleanup
no extra notification-style reason comment

Validation run locally:

node --test .github/scripts/revision-guard/index.test.js

Checklist

Documented (Code comments, README, etc.)
Tested (unit, integration, etc.)

aceppaluni · 2026-05-13T22:17:43Z

Hi @NssGourav Can you link the issue this is solving?

NssGourav · 2026-05-14T03:41:07Z

Hi @NssGourav Can you link the issue this is solving?

Thanks, this PR is intended to solve part of #2264.

More specifically, it implements the event driven CHANGES_REQUESTED -> draft + managed label cleanup slice from the Revision Guard direction we aligned on, while keeping the broader cron side checklist,requirements work separate.

I’ll update the PR description to link it clearly to 2264.

coderabbitai · 2026-05-14T03:56:56Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2172ea0d-7b39-4f7c-8616-7cebdc998db8

📥 Commits

Reviewing files that changed from the base of the PR and between c3537b0 and 8e29a51.

📒 Files selected for processing (1)

.github/workflows/revision-guard.yml

Walkthrough

Adds a revision-guard GitHub Action: helpers for managed-label parsing, draft/bot detection and conversion, label filtering/removal, a handler that converts PRs to draft on "changes_requested" reviews and removes managed labels, accompanying tests, and a workflow that triggers the handler.

Changes

Revision Guard Automation

Layer / File(s)	Summary
Label constants and draft utilities `.github/scripts/revision-guard/helpers/constants.js`, `.github/scripts/revision-guard/helpers/draft.js`	Defines `DEFAULT_MANAGED_LABELS` and `parseManagedLabels`; implements `isBotAuthor`, `isDraft`, and `convertToDraft` (GraphQL mutation).
Label filtering and removal `.github/scripts/revision-guard/helpers/labels.js`	Implements `getManagedLabels()` (env parsing), `getPresentManagedLabels(prLabels, managedLabels)` (normalize/filter), and `removeManagedLabels(github, {owner,repo,issueNumber,labels})` which calls `github.rest.issues.removeLabel` and ignores 404s.
Helper module aggregation `.github/scripts/revision-guard/helpers/index.js`	Re-exports constants, draft, and label helper functions from the helpers directory.
Revision guard handler orchestration `.github/scripts/revision-guard/index.js`	Exports async `revisionGuard({github,context,core})` handler that gates on `changes_requested` reviews, skips bots/drafts, converts PRs to draft, computes present managed labels, and removes them while logging progress.
Tests and workflow trigger `.github/scripts/revision-guard/index.test.js`, `.github/workflows/revision-guard.yml`	Adds tests covering draft conversion, bot skip, draft skip, and env-configurable managed labels; workflow triggers on `pull_request_review` submitted events with `changes_requested`, checks out `.github/scripts` at base SHA, and runs the handler.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'feat: add revision guard draft conversion flow' accurately summarizes the main change—adding a workflow that converts PRs to draft when a changes_requested review is received.
Description check	✅ Passed	The description clearly explains the revision guard feature, implementation scope, managed label handling, and includes test coverage details, all of which align with the changeset.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

Generate code and open pull requests
Plan features and break down work
Investigate incidents and troubleshoot customer tickets together
Automate recurring tasks and respond to alerts with triggers
Summarize progress and report instantly

Built for teams:

Shared memory across your entire org—no repeating context
Per-thread sandboxes to safely plan and execute work
Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 3

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: e411f76b-0725-4f2b-9c8d-78c3834a5b64

📥 Commits

Reviewing files that changed from the base of the PR and between 312db19 and 966864c.

📒 Files selected for processing (7)

.github/scripts/revision-guard/helpers/constants.js
.github/scripts/revision-guard/helpers/draft.js
.github/scripts/revision-guard/helpers/index.js
.github/scripts/revision-guard/helpers/labels.js
.github/scripts/revision-guard/index.js
.github/scripts/revision-guard/index.test.js
.github/workflows/revision-guard.yml

darshit2308

All the 3 coderabbit suggestions are blockers i think, and must be resolved before merging.
I have left another bug in the inline comments, please go through them.
Rest looks good to me.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: cb898582-3029-4601-9b4a-81d2090aea96

📥 Commits

Reviewing files that changed from the base of the PR and between 966864c and ef4d924.

📒 Files selected for processing (4)

.github/scripts/revision-guard/helpers/constants.js
.github/scripts/revision-guard/index.js
.github/scripts/revision-guard/index.test.js
.github/workflows/revision-guard.yml

NssGourav · 2026-05-14T13:44:30Z

Community Workflow Overview

Hey everyone 👋

Just wanted to leave a quick explanation of how this PR behaves end-to-end since the workflow + script interaction can be a little difficult to follow at first glance.

This change is mainly focused on improving the contributor review flow when a reviewer requests changes on a PR.

What Happens When "Request Changes" Is Submitted

When a reviewer clicks Request Changes, GitHub triggers the pull_request_review.submitted event, which starts the revision-guard.yml workflow.

The workflow then goes through the following steps:

Validation & Safety Checks
- Confirms the webhook payload is valid
- Ensures the review state is actually changes_requested
- Skips bot authored PRs
- Skips PRs that are already in draft mode
If any of these checks fail, the workflow exits safely without making changes.
Convert PR Back to Draft
- The PR is converted back to Draft using a GraphQL mutation.
- This is the primary action of the workflow.
Cleanup Managed Labels

After draft conversion, the workflow removes labels related to merge/review readiness, including:
- queue:junior-committer
- queue:committers
- queue:maintainers
- status: ready-to-merge
- status: failed checks
- open to community review
If label cleanup fails for any reason, the error is logged but the workflow itself does not fail since the important draft conversion already completed.

Cases That Are Intentionally Skipped

Situation	Behavior
Review is `approved` or `commented`	No action taken
PR author is a bot	Skipped
PR is already draft	Skipped
Invalid webhook payload	Exits safely with logs

Configurability

Additional labels can be managed through the REVISION_GUARD_MANAGED_LABELS env var. Custom labels are merged with the defaults, not replacing them, so the default cleanup behavior is always preserved.

Validation

All the above cases are covered by unit tests and validated locally:

node --test .github/scripts/revision-guard/index.test.js

▶ revision-guard index
  ✔ converts a ready PR to draft and removes only managed labels
  ✔ skips bot-authored PRs
  ✔ skips already-draft PRs
  ✔ uses configurable managed labels and still removes defaults
✔ revision-guard index — 4 pass, 0 fail

Happy to answer any questions on the design!

Signed-off-by: Gourav NSS <gourav341111@gmail.com>

- fix: add defensive guard on context.payload and context.repo before dereferencing (CodeRabbit major) - fix: parseManagedLabels now merges custom labels with DEFAULT_MANAGED_LABELS instead of silently discarding defaults (darshit2308 blocking) - test: add graphqlCalls assertion in configurable-labels test to catch draft-conversion regressions (CodeRabbit trivial) - fix: checkout uses trusted base SHA instead of PR head/merge ref to prevent fork PRs from running untrusted code with write-scoped token (CodeRabbit critical) Signed-off-by: Gourav NSS <gourav341111@gmail.com>

- convertToDraft re-throws on failure so the workflow fails loudly - removeManagedLabels does not re-throw since draft conversion is the primary goal; a label-cleanup failure is logged via core.error but does not fail the run Signed-off-by: Gourav NSS <gourav341111@gmail.com>

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 270a356c-e3cb-4a12-a24c-6afd9e56857e

📥 Commits

Reviewing files that changed from the base of the PR and between 3f189ba and c3537b0.

📒 Files selected for processing (7)

.github/scripts/revision-guard/helpers/constants.js
.github/scripts/revision-guard/helpers/draft.js
.github/scripts/revision-guard/helpers/index.js
.github/scripts/revision-guard/helpers/labels.js
.github/scripts/revision-guard/index.js
.github/scripts/revision-guard/index.test.js
.github/workflows/revision-guard.yml

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Gourav N S S <gourav341111@gmail.com>

exploreriii · 2026-05-17T09:38:55Z

+  return pr?.draft === true;
+}
+
+async function convertToDraft(github, pullRequestId) {


Hi, have you tested this call works given your permissions?
I took a look at the documentation
https://docs.github.com/en/graphql/reference/input-objects#convertpullrequesttodraftinput
and couldn't find clear permission info, but then saw https://github.com/orgs/community/discussions/24686
Quite possibly this entire PR cannot work without write permissions on the contents, which for obvious reasons we would have to reject and go back to the drawing board

@exploreriii your concern is valid. I found actions/toolkit#1165 which is specifically about convertPullRequestToDraft failing from GitHub Actions with Resource not accessible by integration, and the confirmed fix is adding contents: write. I missed this one while reviewing, @NssGourav could you also please test it with given permissions ?

exploreriii

Requesting more testing

aceppaluni · 2026-05-17T22:22:56Z

@NssGourav For assistance with testing on your fork, pleasure use this link Fork-Testing

github-actions · 2026-05-20T11:00:47Z

Hello, this is the OfficeHourBot.

This is a reminder that the Hiero Python SDK Office Hours will begin in approximately 3 hours (14:00 UTC).

This session provides an opportunity to ask questions regarding this Pull Request.

Details:

Time: 14:00 UTC
Join Link: Zoom Meeting

Disclaimer: This is an automated reminder. Please verify the schedule here for any changes.

From,
The Python SDK Team

NssGourav force-pushed the revision-guard-draft-flow branch from d55b230 to a65d089 Compare May 14, 2026 03:49

NssGourav marked this pull request as ready for review May 14, 2026 03:54

NssGourav requested review from a team as code owners May 14, 2026 03:54

NssGourav requested review from jeromy-cannon and manishdait May 14, 2026 03:54

coderabbitai Bot reviewed May 14, 2026

View reviewed changes

Comment thread .github/scripts/revision-guard/index.js Outdated

Comment thread .github/scripts/revision-guard/index.test.js Outdated

Comment thread .github/workflows/revision-guard.yml

github-actions Bot added open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review labels May 14, 2026

darshit2308 suggested changes May 14, 2026

View reviewed changes

Comment thread .github/scripts/revision-guard/helpers/constants.js Outdated

coderabbitai Bot reviewed May 14, 2026

View reviewed changes

Comment thread .github/scripts/revision-guard/index.js Outdated

darshit2308 approved these changes May 14, 2026

View reviewed changes

github-actions Bot added queue:committers PR awaiting committer technical review and removed queue:junior-committer PR awaiting initial quality review labels May 14, 2026

NssGourav force-pushed the revision-guard-draft-flow branch 2 times, most recently from c22f18f to aa47223 Compare May 14, 2026 14:29

NssGourav requested review from a team as code owners May 14, 2026 14:29

NssGourav requested review from MonaaEid and popowycz May 14, 2026 14:29

NssGourav added 3 commits May 14, 2026 20:01

feat: add revision guard draft conversion flow

c537a55

Signed-off-by: Gourav NSS <gourav341111@gmail.com>

NssGourav force-pushed the revision-guard-draft-flow branch from aa47223 to c3537b0 Compare May 14, 2026 14:31

coderabbitai Bot reviewed May 14, 2026

View reviewed changes

Comment thread .github/workflows/revision-guard.yml

Update .github/workflows/revision-guard.yml

533d4f3

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Gourav N S S <gourav341111@gmail.com>

Merge branch 'main' into revision-guard-draft-flow

8e29a51

This comment has been minimized.

Sign in to view

github-actions Bot closed this May 15, 2026

MonaaEid reopened this May 15, 2026

MonaaEid linked an issue May 15, 2026 that may be closed by this pull request

feat: implement revision-guard for automated PR drafting and queue health management #2264

Open

exploreriii reviewed May 17, 2026

View reviewed changes

exploreriii requested changes May 17, 2026

View reviewed changes

exploreriii marked this pull request as draft May 17, 2026 17:30

aceppaluni added the status: Needs Developer Revision Author needs to apply suggested changes/improvements label May 18, 2026

Conversation

NssGourav commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aceppaluni commented May 13, 2026

Uh oh!

NssGourav commented May 14, 2026

Uh oh!

coderabbitai Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

darshit2308 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NssGourav commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Workflow Overview

What Happens When "Request Changes" Is Submitted

Cases That Are Intentionally Skipped

Configurability

Validation

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

exploreriii May 17, 2026

Choose a reason for hiding this comment

Uh oh!

darshit2308 May 17, 2026

Choose a reason for hiding this comment

Uh oh!

exploreriii left a comment

Choose a reason for hiding this comment

Uh oh!

aceppaluni commented May 17, 2026

Uh oh!

github-actions Bot commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

NssGourav commented May 13, 2026 •

edited

Loading

coderabbitai Bot commented May 14, 2026 •

edited

Loading

NssGourav commented May 14, 2026 •

edited

Loading