add force-cancel workflow run

Author: cyrilico

src/main/java/org/kohsuke/github/GHWorkflowRun.java

@@ -209,6 +209,7 @@ public String toString() {
     }
     private GHUser actor;
     private String artifactsUrl;
+    private String forceCancelUrl;
     private String cancelUrl;
     private String checkSuiteUrl;
 
@@ -267,6 +268,16 @@ public void cancel() throws IOException {
         root().createRequest().method("POST").withUrlPath(getApiRoute(), "cancel").send();
     }
 
+    /**
+     * Force-cancel the workflow run.
+     *
+     * @throws IOException
+     *             the io exception
+     */
+    public void forceCancel() throws IOException {
+        root().createRequest().method("POST").withUrlPath(getApiRoute(), "force-cancel").send();
+    }
+
     /**
      * Delete the workflow run.
      *
@@ -336,6 +347,15 @@ public URL getCancelUrl() {
         return GitHubClient.parseURL(cancelUrl);
     }
 
+    /**
+     * The cancel URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/force-cancel
+     *
+     * @return the cancel url
+     */
+    public URL getForceCancelUrl() {
+        return GitHubClient.parseURL(forceCancelUrl);
+    }
+
     /**
      * The check suite URL, like https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374
      *

src/test/java/org/kohsuke/github/GHEventPayloadTest.java

@@ -1795,6 +1795,8 @@ public void workflow_run() throws Exception {
                 is("https://api.github.com/repos/gsmet/quarkus-bot-java-playground/check-suites/2327154397"));
         assertThat(workflowRun.getArtifactsUrl().toString(),
                 is("https://api.github.com/repos/gsmet/quarkus-bot-java-playground/actions/runs/680604745/artifacts"));
+        assertThat(workflowRun.getForceCancelUrl().toString(),
+                is("https://api.github.com/repos/gsmet/quarkus-bot-java-playground/actions/runs/680604745/force-cancel"));
         assertThat(workflowRun.getCancelUrl().toString(),
                 is("https://api.github.com/repos/gsmet/quarkus-bot-java-playground/actions/runs/680604745/cancel"));
         assertThat(workflowRun.getRerunUrl().toString(),

src/test/java/org/kohsuke/github/GHWorkflowRunTest.java

@@ -420,6 +420,46 @@ public void testCancelAndRerun() throws IOException {
         workflowRun.cancel();
     }
 
+    /**
+     * Test force cancel a run.
+     *
+     * @throws IOException
+     *             Signals that an I/O exception has occurred.
+     */
+    @Test
+    public void testForceCancel() throws IOException {
+        GHWorkflow workflow = repo.getWorkflow(SLOW_WORKFLOW_PATH);
+
+        long latestPreexistingWorkflowRunId = getLatestPreexistingWorkflowRunId();
+
+        workflow.dispatch(MAIN_BRANCH);
+
+        // now that we have triggered the workflow run, we will wait until it's in progress and then force cancel it
+        await((nonRecordingRepo) -> getWorkflowRun(nonRecordingRepo,
+                SLOW_WORKFLOW_NAME,
+                MAIN_BRANCH,
+                Status.IN_PROGRESS,
+                latestPreexistingWorkflowRunId).isPresent());
+
+        GHWorkflowRun workflowRun = getWorkflowRun(SLOW_WORKFLOW_NAME,
+                MAIN_BRANCH,
+                Status.IN_PROGRESS,
+                latestPreexistingWorkflowRunId)
+                .orElseThrow(() -> new IllegalStateException("We must have a valid workflow run starting from here"));
+
+        assertThat(workflowRun.getId(), notNullValue());
+
+        workflowRun.forceCancel();
+        long cancelledWorkflowRunId = workflowRun.getId();
+
+        // let's wait until it's completed
+        await((nonRecordingRepo) -> getWorkflowRunStatus(nonRecordingRepo, cancelledWorkflowRunId) == Status.COMPLETED);
+
+        // let's check that it has been properly cancelled
+        workflowRun = repo.getWorkflowRun(cancelledWorkflowRunId);
+        assertThat(workflowRun.getConclusion(), equalTo(Conclusion.CANCELLED));
+    }
+
     /**
      * Test delete.
      *
@@ -591,6 +631,7 @@ public void testManualRunAndBasicInformation() throws IOException {
         assertThat(workflowRun.getCheckSuiteUrl().getPath(), containsString("/check-suites/"));
         assertThat(workflowRun.getArtifactsUrl().getPath(), endsWith("/artifacts"));
         assertThat(workflowRun.getCancelUrl().getPath(), endsWith("/cancel"));
+        assertThat(workflowRun.getForceCancelUrl().getPath(), endsWith("/force-cancel"));
         assertThat(workflowRun.getRerunUrl().getPath(), endsWith("/rerun"));
         assertThat(workflowRun.getWorkflowUrl().getPath(), containsString("/actions/workflows/"));
         assertThat(workflowRun.getHeadBranch(), equalTo(MAIN_BRANCH));

src/test/java/org/kohsuke/github/GHWorkflowTest.java

@@ -35,6 +35,7 @@ private static void checkWorkflowRunProperties(GHWorkflowRun workflowRun, long w
         assertThat(workflowRun.getCheckSuiteUrl().getPath(), containsString("/check-suites/"));
         assertThat(workflowRun.getArtifactsUrl().getPath(), endsWith("/artifacts"));
         assertThat(workflowRun.getCancelUrl().getPath(), endsWith("/cancel"));
+        assertThat(workflowRun.getForceCancelUrl().getPath(), endsWith("/force-cancel"));
         assertThat(workflowRun.getRerunUrl().getPath(), endsWith("/rerun"));
         assertThat(workflowRun.getWorkflowUrl().getPath(), containsString("/actions/workflows/"));
         assertThat(workflowRun.getHeadBranch(), equalTo("main"));