convert to draft on branch updates when there is a diff with base

Author: peter-evans

README.md

@@ -72,7 +72,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
 | `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
 | `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token), or equivalent [GitHub App permissions](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens), are required. | |
 | `milestone` | The number of the milestone to associate this pull request with. | |
-| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). It is not possible to change draft status after creation except through the web interface. | `false` |
+| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). Valid values are `true` (only on create), `always-true` (on create and update), and `false`.  | `false` |
 | `maintainer-can-modify` | Indicates whether [maintainers can modify](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) the pull request. | `true` |
 
 #### token

action.yml

@@ -75,7 +75,9 @@ inputs:
   milestone:
     description: 'The number of the milestone to associate the pull request with.'
   draft:
-    description: 'Create a draft pull request. It is not possible to change draft status after creation except through the web interface'
+    description: >
+      Create a draft pull request.
+      Valid values are `true` (only on create), `always-true` (on create and update), and `false`.
     default: false
   maintainer-can-modify:
     description: 'Indicates whether maintainers can modify the pull request.'

dist/index.js

@@ -495,6 +495,11 @@ function createPullRequest(inputs) {
                 }
                 else if (result.action == 'updated') {
                     outputs.set('pull-request-operation', 'updated');
+                    // The pull request was updated AND the branch was updated.
+                    // Convert back to draft if 'draft: always-true' is set.
+                    if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
+                        yield ghPull.convertToDraft(pull.node_id);
+                    }
                 }
                 core.endGroup();
             }
@@ -1306,28 +1311,9 @@ class GitHubHelper {
                     throw e;
                 }
             }
-            // Convert back to draft if 'draft: always-true' is set
-            if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
-                yield this.convertToDraft(pull.node_id);
-            }
             return pull;
         });
     }
-    convertToDraft(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            core.info(`Converting pull request to draft`);
-            yield this.octokit.graphql({
-                query: `mutation($pullRequestId: ID!) {
-        convertPullRequestToDraft(input: {pullRequestId: $pullRequestId}) {
-          pullRequest {
-            isDraft
-          }
-        }
-      }`,
-                pullRequestId: id
-            });
-        });
-    }
     pushSignedCommits(branchCommits, baseSha, repoPath, branchRepository, branch) {
         return __awaiter(this, void 0, void 0, function* () {
             let headCommit = {
@@ -1401,6 +1387,21 @@ class GitHubHelper {
             }
         });
     }
+    convertToDraft(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            core.info(`Converting pull request to draft`);
+            yield this.octokit.graphql({
+                query: `mutation($pullRequestId: ID!) {
+        convertPullRequestToDraft(input: {pullRequestId: $pullRequestId}) {
+          pullRequest {
+            isDraft
+          }
+        }
+      }`,
+                pullRequestId: id
+            });
+        });
+    }
 }
 exports.GitHubHelper = GitHubHelper;
 

docs/concepts-guidelines.md

@@ -150,7 +150,7 @@ There are a number of workarounds with different pros and cons.
 
 - Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. To prevent merging of pull requests without checks erroneously, use [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests).
 
-- Create draft pull requests by setting the `draft: true` input, and configure your workflow to trigger `on: ready_for_review`. The workflow will run when users manually click the "Ready for review" button on the draft pull requests.
+- Create draft pull requests by setting the `draft: always-true` input, and configure your workflow to trigger `on: ready_for_review`. The workflow will run when users manually click the "Ready for review" button on the draft pull requests. If the pull request is updated by the action, the `always-true` mode ensures that the pull request will be converted back to a draft.
 
 - Use a [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) created on an account that has write access to the repository that pull requests are being created in. This is the standard workaround and [recommended by GitHub](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow). It's advisable to use a dedicated [machine account](https://docs.github.com/en/github/site-policy/github-terms-of-service#3-account-requirements) that has collaborator access to the repository, rather than creating a PAT on a personal user account. Also note that because the account that owns the PAT will be the creator of pull requests, that user account will be unable to perform actions such as request changes or approve the pull request.
 

src/create-pull-request.ts

@@ -249,6 +249,11 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
         outputs.set('pull-request-operation', 'created')
       } else if (result.action == 'updated') {
         outputs.set('pull-request-operation', 'updated')
+        // The pull request was updated AND the branch was updated.
+        // Convert back to draft if 'draft: always-true' is set.
+        if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
+          await ghPull.convertToDraft(pull.node_id)
+        }
       }
       core.endGroup()
     } else {

src/github-helper.ts

@@ -215,28 +215,9 @@ export class GitHubHelper {
       }
     }
 
-    // Convert back to draft if 'draft: always-true' is set
-    if (inputs.draft.always && pull.draft !== undefined && !pull.draft) {
-      await this.convertToDraft(pull.node_id)
-    }
-
     return pull
   }
 
-  private async convertToDraft(id: string): Promise<void> {
-    core.info(`Converting pull request to draft`)
-    await this.octokit.graphql({
-      query: `mutation($pullRequestId: ID!) {
-        convertPullRequestToDraft(input: {pullRequestId: $pullRequestId}) {
-          pullRequest {
-            isDraft
-          }
-        }
-      }`,
-      pullRequestId: id
-    })
-  }
-
   async pushSignedCommits(
     branchCommits: Commit[],
     baseSha: string,
@@ -368,4 +349,18 @@ export class GitHubHelper {
       })
     }
   }
+
+  async convertToDraft(id: string): Promise<void> {
+    core.info(`Converting pull request to draft`)
+    await this.octokit.graphql({
+      query: `mutation($pullRequestId: ID!) {
+        convertPullRequestToDraft(input: {pullRequestId: $pullRequestId}) {
+          pullRequest {
+            isDraft
+          }
+        }
+      }`,
+      pullRequestId: id
+    })
+  }
 }