github: make attempts optional in workflowRunURL

crazy-max · crazy-max · commit fe58cc26f5e1 · 2024-06-12T09:22:43.000+02:00
Signed-off-by: CrazyMax &lt;1951866+crazy-max@users.noreply.github.com&gt;
diff --git a/__tests__/github.test.ts b/__tests__/github.test.ts
@@ -97,7 +97,10 @@ describe('repository', () => {
 
 describe('workflowRunURL', () => {
   it('returns 2188748038', async () => {
-    expect(GitHub.workflowRunURL).toEqual('https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2');
+    expect(GitHub.workflowRunURL()).toEqual('https://github.com/docker/actions-toolkit/actions/runs/2188748038');
+  });
+  it('returns 2188748038 with attempts 2', async () => {
+    expect(GitHub.workflowRunURL(true)).toEqual('https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2');
   });
 });
 
diff --git a/src/buildx/build.ts b/src/buildx/build.ts
@@ -131,7 +131,7 @@ export class Build {
       return input;
     }
     try {
-      return core.getBooleanInput(name) ? `builder-id=${GitHub.workflowRunURL}` : 'false';
+      return core.getBooleanInput(name) ? `builder-id=${GitHub.workflowRunURL(true)}` : 'false';
     } catch (err) {
       // not a valid boolean, so we assume it's a string
       return Build.resolveProvenanceAttrs(input);
@@ -140,7 +140,7 @@ export class Build {
 
   public static resolveProvenanceAttrs(input: string): string {
     if (!input) {
-      return `builder-id=${GitHub.workflowRunURL}`;
+      return `builder-id=${GitHub.workflowRunURL(true)}`;
     }
     // parse attributes from input
     const fields = parse(input, {
@@ -158,7 +158,7 @@ export class Build {
       }
     }
     // if not add builder-id attribute
-    return `${input},builder-id=${GitHub.workflowRunURL}`;
+    return `${input},builder-id=${GitHub.workflowRunURL(true)}`;
   }
 
   public static resolveCacheToAttrs(input: string, githubToken?: string): string {
diff --git a/src/github.ts b/src/github.ts
@@ -68,10 +68,10 @@ export class GitHub {
     return `${github.context.repo.owner}/${github.context.repo.repo}`;
   }
 
-  static get workflowRunURL(): string {
-    const runID = process.env.GITHUB_RUN_ID || github.context.runId;
-    const runAttempt = process.env.GITHUB_RUN_ATTEMPT || 1;
-    return `${GitHub.serverURL}/${GitHub.repository}/actions/runs/${runID}/attempts/${runAttempt}`;
+  public static workflowRunURL(setAttempts?: boolean): string {
+    // TODO: runAttempt is not yet part of github.context but will be in a
+    //  future release of @actions/github package: https://github.com/actions/toolkit/commit/faa425440f86f9c16587a19dfb59491253a2c92a
+    return `${GitHub.serverURL}/${GitHub.repository}/actions/runs/${github.context.runId}${setAttempts ? `/attempts/${process.env.GITHUB_RUN_ATTEMPT || 1}` : ''}`;
   }
 
   static get actionsRuntimeToken(): GitHubActionsRuntimeToken | undefined {
@@ -191,7 +191,7 @@ export class GitHub {
     const artifactId = BigInt(finalizeArtifactResp.artifactId);
     core.info(`Artifact successfully finalized (${artifactId})`);
 
-    const artifactURL = `${GitHub.workflowRunURL}/artifacts/${artifactId}`;
+    const artifactURL = `${GitHub.workflowRunURL()}/artifacts/${artifactId}`;
     core.info(`Artifact download URL: ${artifactURL}`);
 
     return {

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ export class Build {`
`131`	`131`	`return input;`
`132`	`132`	`}`
`133`	`133`	`try {`
`134`		- return core.getBooleanInput(name) ? `builder-id=${GitHub.workflowRunURL}` : 'false';
	`134`	+ return core.getBooleanInput(name) ? `builder-id=${GitHub.workflowRunURL(true)}` : 'false';
`135`	`135`	`} catch (err) {`
`136`	`136`	`// not a valid boolean, so we assume it's a string`
`137`	`137`	`return Build.resolveProvenanceAttrs(input);`
`@@ -140,7 +140,7 @@ export class Build {`
`140`	`140`
`141`	`141`	`public static resolveProvenanceAttrs(input: string): string {`
`142`	`142`	`if (!input) {`
`143`		- return `builder-id=${GitHub.workflowRunURL}`;
	`143`	+ return `builder-id=${GitHub.workflowRunURL(true)}`;
`144`	`144`	`}`
`145`	`145`	`// parse attributes from input`
`146`	`146`	`const fields = parse(input, {`
`@@ -158,7 +158,7 @@ export class Build {`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`	`// if not add builder-id attribute`
`161`		- return `${input},builder-id=${GitHub.workflowRunURL}`;
	`161`	+ return `${input},builder-id=${GitHub.workflowRunURL(true)}`;
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`public static resolveCacheToAttrs(input: string, githubToken?: string): string {`