Feature request: Option to move a PR from "open" to "draft"

Open
#1,130 3 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, typescript
Domain
ci-cd, devops

Research direction

The issue names no files or tests; start by tracing the stale action's existing two-level workflow and how it performs pull-request actions. Compare the requested three-level workflow with the simpler stale subaction alternative, then verify that configuration, comments, labels, draft transitions, and closing occur in the intended order.

Written by the indexing model from the issue text.

Description

feature request

Description:

Currently the stale action allows a 2-level workflow:

  • after X days: mark as stale (+add comment, add label)
  • after Y days: close the PR

It could be interesting to allow a 3-level workflow:

  • after X days: move PR from "open" to "draft" (+optionally add comment)
  • after Y days: mark as stale (+add comment, add label)
  • after Z days: close the PR

Alternatively, if this sounds too complicated, an easier first step would be to "move to draft" as an subaction of marking as stale:

  • after X days: mark as stale (optionally add comment, optionally add label, +optionally move to draft)
  • after Y days: close the PR

Justification:

Personally I find marking PRs as "stale" and closing them as "this should only happen on very old PRs" (many months old). Whereas moving back to draft is "less dramatic".

  • Draft PRs are a standard GH feature and have semantically different meaning and behavior.
    • For example, PR marked as draft can't be merged by accident.
  • Marking PR as draft is leagues better than adding a label:
    • drafts are visually distinct from other PRs:
      • in PR detail view /pull/<n> (status icon in top-left of the PR)
      • in PR list /pulls, drafts have a different icon as well
    • drafts are searchable and can be excluded via a standard -is:draft query in GitHub searchbox, the query will be the same across all repositories.
      • For example one can find all review requests assigned to them on non-draft PRs via this query is:pr is:open user-review-requested:@me -is:draft
      • (To be fair, one could argue that the same can be achieved by -label:stale, although the label can be different in each repo, depending on the config).
  • There are certain third-party integrations for the PRs which have an option to exclude draft PRs. For example GitHub-Slack integration which reminds about pending PR reviews.

Are you willing to submit a PR?

No

Dominant language
TypeScript
Stars
1.7k
Forks
438
Avg merge
27d 8h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from actions/stale

All issues in actions/stale

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.