Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 4d14405

Browse filesBrowse files
author
Serkan ÖZAL
committed
Added list-workflow-runs API
1 parent dae92fc commit 4d14405
Copy full SHA for 4d14405
Expand file treeCollapse file tree

15 files changed

+830
-10
lines changed

‎src/main/java/org/kohsuke/github/GHOrganization.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GHOrganization.java
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,9 @@ public GHHook getHook(int id) throws IOException {
644644
* Deletes hook.
645645
*
646646
* @param id
647+
* the id
647648
* @throws IOException
649+
* the io exception
648650
*/
649651
public void deleteHook(int id) throws IOException {
650652
GHHooks.orgContext(this).deleteHook(id);

‎src/main/java/org/kohsuke/github/GHWorkflow.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GHWorkflow.java
+9Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,15 @@ public void dispatch(String ref, Map<String, Object> inputs) throws IOException
136136
requester.fetchHttpStatusCode();
137137
}
138138

139+
/**
140+
* Lists the workflow runs belong to this workflow.
141+
*
142+
* @return the paged iterable
143+
*/
144+
public PagedIterable<GHWorkflowRun> listRuns() {
145+
return new GHWorkflowRunsIterable(owner, root().createRequest().withUrlPath(getApiRoute(), "runs"));
146+
}
147+
139148
private String getApiRoute() {
140149
if (owner == null) {
141150
// Workflow runs returned from search to do not have an owner. Attempt to use url.

‎src/main/java/org/kohsuke/github/GHWorkflowRunQueryBuilder.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GHWorkflowRunQueryBuilder.java
+1-7Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
import org.kohsuke.github.GHWorkflowRun.Status;
44

5-
import java.net.MalformedURLException;
6-
75
/**
86
* Lists up workflow runs with some filtering and sorting.
97
*
@@ -92,10 +90,6 @@ public GHWorkflowRunQueryBuilder status(Status status) {
9290

9391
@Override
9492
public PagedIterable<GHWorkflowRun> list() {
95-
try {
96-
return new GHWorkflowRunsIterable(repo, req.withUrlPath(repo.getApiTailUrl("actions/runs")).build());
97-
} catch (MalformedURLException e) {
98-
throw new GHException(e.getMessage(), e);
99-
}
93+
return new GHWorkflowRunsIterable(repo, req.withUrlPath(repo.getApiTailUrl("actions/runs")));
10094
}
10195
}

‎src/main/java/org/kohsuke/github/GHWorkflowRunsIterable.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GHWorkflowRunsIterable.java
+7-2Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.kohsuke.github;
22

3+
import java.net.MalformedURLException;
34
import java.util.Iterator;
45

56
import javax.annotation.Nonnull;
@@ -13,9 +14,13 @@ class GHWorkflowRunsIterable extends PagedIterable<GHWorkflowRun> {
1314

1415
private GHWorkflowRunsPage result;
1516

16-
public GHWorkflowRunsIterable(GHRepository owner, GitHubRequest request) {
17+
public GHWorkflowRunsIterable(GHRepository owner, GitHubRequest.Builder<?> requestBuilder) {
1718
this.owner = owner;
18-
this.request = request;
19+
try {
20+
this.request = requestBuilder.build();
21+
} catch (MalformedURLException e) {
22+
throw new GHException("Malformed URL", e);
23+
}
1924
}
2025

2126
@Nonnull

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

Copy file name to clipboardExpand all lines: src/test/java/org/kohsuke/github/GHWorkflowTest.java
+41-1Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor;
1313
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
1414
import static com.github.tomakehurst.wiremock.client.WireMock.verify;
15-
import static org.hamcrest.Matchers.equalTo;
15+
import static org.hamcrest.Matchers.*;
16+
import static org.hamcrest.Matchers.notNullValue;
1617

1718
public class GHWorkflowTest extends AbstractGitHubWireMockTest {
1819

@@ -108,4 +109,43 @@ public void testListWorkflows() throws IOException {
108109
assertThat(workflow.getBadgeUrl().getPath(),
109110
equalTo("/hub4j-test-org/GHWorkflowTest/workflows/test-workflow/badge.svg"));
110111
}
112+
113+
@Test
114+
public void testListWorkflowRuns() throws IOException {
115+
GHWorkflow workflow = repo.getWorkflow("test-workflow.yml");
116+
117+
List<GHWorkflowRun> workflowRuns = workflow.listRuns().toList();
118+
assertThat(workflowRuns.size(), is(2));
119+
120+
checkWorkflowRunProperties(workflowRuns.get(0), workflow.getId());
121+
checkWorkflowRunProperties(workflowRuns.get(1), workflow.getId());
122+
}
123+
124+
private static void checkWorkflowRunProperties(GHWorkflowRun workflowRun, long workflowId) throws IOException {
125+
assertThat(workflowRun.getWorkflowId(), equalTo(workflowId));
126+
assertThat(workflowRun.getId(), notNullValue());
127+
assertThat(workflowRun.getNodeId(), notNullValue());
128+
assertThat(workflowRun.getRepository().getFullName(), equalTo(REPO_NAME));
129+
assertThat(workflowRun.getUrl().getPath(), containsString("/actions/runs/"));
130+
assertThat(workflowRun.getHtmlUrl().getPath(), containsString("/actions/runs/"));
131+
assertThat(workflowRun.getJobsUrl().getPath(), endsWith("/jobs"));
132+
assertThat(workflowRun.getLogsUrl().getPath(), endsWith("/logs"));
133+
assertThat(workflowRun.getCheckSuiteUrl().getPath(), containsString("/check-suites/"));
134+
assertThat(workflowRun.getArtifactsUrl().getPath(), endsWith("/artifacts"));
135+
assertThat(workflowRun.getCancelUrl().getPath(), endsWith("/cancel"));
136+
assertThat(workflowRun.getRerunUrl().getPath(), endsWith("/rerun"));
137+
assertThat(workflowRun.getWorkflowUrl().getPath(), containsString("/actions/workflows/"));
138+
assertThat(workflowRun.getHeadBranch(), equalTo("main"));
139+
assertThat(workflowRun.getHeadCommit().getId(), notNullValue());
140+
assertThat(workflowRun.getHeadCommit().getTreeId(), notNullValue());
141+
assertThat(workflowRun.getHeadCommit().getMessage(), notNullValue());
142+
assertThat(workflowRun.getHeadCommit().getTimestamp(), notNullValue());
143+
assertThat(workflowRun.getHeadCommit().getAuthor().getEmail(), notNullValue());
144+
assertThat(workflowRun.getHeadCommit().getCommitter().getEmail(), notNullValue());
145+
assertThat(workflowRun.getEvent(), equalTo(GHEvent.WORKFLOW_DISPATCH));
146+
assertThat(workflowRun.getStatus(), equalTo(GHWorkflowRun.Status.COMPLETED));
147+
assertThat(workflowRun.getConclusion(), equalTo(GHWorkflowRun.Conclusion.SUCCESS));
148+
assertThat(workflowRun.getHeadSha(), notNullValue());
149+
}
150+
111151
}

‎src/test/resources/org/kohsuke/github/GHWorkflowTest/wiremock/testListWorkflowRuns/__files/repos_hub4j-test-org_ghworkflowtest-2.json

Copy file name to clipboard
+126Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
{
2+
"id": 348651606,
3+
"node_id": "MDEwOlJlcG9zaXRvcnkzNDg2NTE2MDY=",
4+
"name": "GHWorkflowTest",
5+
"full_name": "hub4j-test-org/GHWorkflowTest",
6+
"private": false,
7+
"owner": {
8+
"login": "hub4j-test-org",
9+
"id": 7544739,
10+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
11+
"avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
12+
"gravatar_id": "",
13+
"url": "https://api.github.com/users/hub4j-test-org",
14+
"html_url": "https://github.com/hub4j-test-org",
15+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
16+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
17+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
18+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
19+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
20+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
21+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
22+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
23+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
24+
"type": "Organization",
25+
"site_admin": false
26+
},
27+
"html_url": "https://github.com/hub4j-test-org/GHWorkflowTest",
28+
"description": "Repository used for GHWorkflowTest",
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowTest/deployments",
67+
"created_at": "2021-03-17T09:32:03Z",
68+
"updated_at": "2021-03-17T09:33:34Z",
69+
"pushed_at": "2021-03-17T09:33:32Z",
70+
"git_url": "git://github.com/hub4j-test-org/GHWorkflowTest.git",
71+
"ssh_url": "git@github.com:hub4j-test-org/GHWorkflowTest.git",
72+
"clone_url": "https://github.com/hub4j-test-org/GHWorkflowTest.git",
73+
"svn_url": "https://github.com/hub4j-test-org/GHWorkflowTest",
74+
"homepage": null,
75+
"size": 1,
76+
"stargazers_count": 0,
77+
"watchers_count": 0,
78+
"language": null,
79+
"has_issues": true,
80+
"has_projects": true,
81+
"has_downloads": true,
82+
"has_wiki": true,
83+
"has_pages": false,
84+
"forks_count": 0,
85+
"mirror_url": null,
86+
"archived": false,
87+
"disabled": false,
88+
"open_issues_count": 0,
89+
"license": null,
90+
"forks": 0,
91+
"open_issues": 0,
92+
"watchers": 0,
93+
"default_branch": "main",
94+
"permissions": {
95+
"admin": true,
96+
"push": true,
97+
"pull": true
98+
},
99+
"temp_clone_token": "",
100+
"allow_squash_merge": true,
101+
"allow_merge_commit": true,
102+
"allow_rebase_merge": true,
103+
"delete_branch_on_merge": false,
104+
"organization": {
105+
"login": "hub4j-test-org",
106+
"id": 7544739,
107+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
108+
"avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
109+
"gravatar_id": "",
110+
"url": "https://api.github.com/users/hub4j-test-org",
111+
"html_url": "https://github.com/hub4j-test-org",
112+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
113+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
114+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
115+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
116+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
117+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
118+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
119+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
120+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
121+
"type": "Organization",
122+
"site_admin": false
123+
},
124+
"network_count": 0,
125+
"subscribers_count": 10
126+
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.