Merge pull request #1078 from gsmet/expose-repository-workflows-artifacts

Expose repository for artifacts, workflows and workflow runs

Author: bitwiseman

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

@@ -28,26 +28,60 @@ public class GHArtifact extends GHObject {
     private boolean expired;
     private String expiresAt;
 
+    /**
+     * Gets the name.
+     *
+     * @return the name
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Gets the size of the artifact in bytes.
+     *
+     * @return the size
+     */
     public long getSizeInBytes() {
         return sizeInBytes;
     }
 
+    /**
+     * Gets the archive download URL.
+     *
+     * @return the archive download URL
+     */
     public URL getArchiveDownloadUrl() {
         return GitHubClient.parseURL(archiveDownloadUrl);
     }
 
+    /**
+     * If this artifact has expired.
+     *
+     * @return if the artifact has expired
+     */
     public boolean isExpired() {
         return expired;
     }
 
+    /**
+     * Gets the date at which this artifact will expire.
+     *
+     * @return the date of expiration
+     */
     public Date getExpiresAt() {
         return GitHubClient.parseDate(expiresAt);
     }
 
+    /**
+     * Repository to which the artifact belongs.
+     *
+     * @return the repository
+     */
+    public GHRepository getRepository() {
+        return owner;
+    }
+
     /**
      * @deprecated This object has no HTML URL.
      */

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

@@ -60,6 +60,15 @@ public URL getHtmlUrl() throws IOException {
         return GitHubClient.parseURL(htmlUrl);
     }
 
+    /**
+     * Repository to which the workflow belongs.
+     *
+     * @return the repository
+     */
+    public GHRepository getRepository() {
+        return owner;
+    }
+
     /**
      * The badge URL, like https://github.com/octo-org/octo-repo/workflows/CI/badge.svg
      *

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

@@ -213,6 +213,15 @@ public Conclusion getConclusion() {
         return Conclusion.from(conclusion);
     }
 
+    /**
+     * Repository to which the workflow run belongs.
+     *
+     * @return the repository
+     */
+    public GHRepository getRepository() {
+        return owner;
+    }
+
     /**
      * Gets the pull requests participated in this workflow run.
      *

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

@@ -62,6 +62,9 @@ public void testManualRunAndBasicInformation() throws IOException {
                         () -> new IllegalStateException("We must have a valid workflow run starting from here"));
 
         assertEquals(workflow.getId(), workflowRun.getWorkflowId());
+        assertNotNull(workflowRun.getId());
+        assertNotNull(workflowRun.getNodeId());
+        assertEquals(REPO_NAME, workflowRun.getRepository().getFullName());
         assertTrue(workflowRun.getUrl().getPath().contains("/actions/runs/"));
         assertTrue(workflowRun.getHtmlUrl().getPath().contains("/actions/runs/"));
         assertTrue(workflowRun.getJobsUrl().getPath().endsWith("/jobs"));
@@ -379,6 +382,7 @@ private static Status getWorkflowRunStatus(GHRepository repository, long workflo
     private static void checkArtifactProperties(GHArtifact artifact, String artifactName) throws IOException {
         assertNotNull(artifact.getId());
         assertNotNull(artifact.getNodeId());
+        assertEquals(REPO_NAME, artifact.getRepository().getFullName());
         assertThat(artifact.getName(), is(artifactName));
         assertThat(artifact.getArchiveDownloadUrl().getPath(), containsString("actions/artifacts"));
         assertNotNull(artifact.getCreatedAt());

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

@@ -43,6 +43,7 @@ public void testBasicInformation() throws IOException {
         GHWorkflow workflow = repo.getWorkflow("test-workflow.yml");
 
         assertEquals("test-workflow", workflow.getName());
+        assertEquals(REPO_NAME, workflow.getRepository().getFullName());
         assertEquals(".github/workflows/test-workflow.yml", workflow.getPath());
         assertEquals("active", workflow.getState());
         assertEquals("/repos/hub4j-test-org/GHWorkflowTest/actions/workflows/6817859", workflow.getUrl().getPath());