Package io.jenkins.plugins.ghacloud

Class GitHubClient

java.lang.Object

io.jenkins.plugins.ghacloud.GitHubClient

public class GitHubClient
extends Object

Minimal GitHub REST API client for triggering workflow_dispatch events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubClient.DispatchResult	Result of a workflow dispatch containing the run ID and URLs.
static class	GitHubClient.WorkflowRunStatus	Represents the status of a GitHub Actions workflow run.

Constructor Summary

Constructors

Constructor	Description
GitHubClient(String apiUrl, String token)

Method Summary

Modifier and Type	Method	Description
void	createWorkflowAnnotation(String repository, long runId, String message, String buildUrl)	Creates a notice annotation on a workflow run by posting a check run with an annotation output.
GitHubClient.WorkflowRunStatus	getWorkflowRunStatus(String repository, long runId)	Gets the current status of a workflow run.
GitHubClient.DispatchResult	triggerWorkflow(String repository, String workflowFile, String ref, Map<String,String> inputs)	Triggers a workflow_dispatch event on the specified repository and workflow file.
void	updateWorkflowRunName(String repository, long runId, String name)	Updates the display name of a workflow run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GitHubClient

public GitHubClient(String apiUrl,
 String token)

Method Details

triggerWorkflow

public GitHubClient.DispatchResult triggerWorkflow(String repository,
 String workflowFile,
 String ref,
 Map<String,String> inputs)
                                            throws IOException

Triggers a workflow_dispatch event on the specified repository and workflow file.

Parameters:

repository - owner/repo

workflowFile - the workflow filename (e.g. jenkins-agent.yml)

ref - git ref to run against (e.g. main)

inputs - key-value inputs forwarded to the workflow

Returns:

dispatch result containing the workflow run ID and URLs

Throws:

IOException

getWorkflowRunStatus

public GitHubClient.WorkflowRunStatus getWorkflowRunStatus(String repository,
 long runId)
                                                    throws IOException

Gets the current status of a workflow run.

Throws:

IOException

updateWorkflowRunName

public void updateWorkflowRunName(String repository,
 long runId,
 String name)
                           throws IOException

Updates the display name of a workflow run.

Throws:

IOException

createWorkflowAnnotation

public void createWorkflowAnnotation(String repository,
 long runId,
 String message,
 String buildUrl)
                              throws IOException

Creates a notice annotation on a workflow run by posting a check run with an annotation output.

Parameters:

repository - owner/repo

runId - the workflow run ID

message - annotation message

buildUrl - link back to the Jenkins build

Throws:

IOException