release: automatically discover artifact

francoisferrand · francoisferrand · commit b88f0d8fe0e3 · 2025-08-01T12:29:49.000+02:00
If the artifact-name input is not provided, use github API to retrieve the job runs associated with the commit being released to build the artifact name. Issue: ZENKO-5046
diff --git a/.github/scripts/get-build-artifact.js b/.github/scripts/get-build-artifact.js
@@ -0,0 +1,52 @@
+/**
+ * Auto-derive artifacts name from successful staging build
+ * 
+ * This script is used in GitHub Actions to automatically find and construct
+ * the artifacts name from a successful staging workflow run that contains
+ * the build-iso-and-end2end-test job.
+ * 
+ * @param {Object} github - GitHub Actions toolkit github object
+ * @param {Object} context - GitHub Actions context object
+ * @param {Object} core - GitHub Actions core object for logging/errors
+ * @returns {Promise<string>} The constructed artifacts name
+ */
+async function getBuildArtifact(github, context, core) {
+  const workflow_id = 'build-iso-and-end2end-test'; // The workflow ID for the build job
+
+  // Get the commit SHA for the tag
+  const tagCommit = context.sha;
+  core.info(`Looking for successful builds for commit: ${tagCommit}`);
+  
+  // Get workflow runs for this repository``
+  const { data: workflowRuns } = await github.rest.actions.listWorkflowRuns({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    workflow_id,
+    head_sha: tagCommit,
+    status: 'completed',
+    conclusion: 'success'
+  });
+  
+  // Find the first successful staging workflow run
+  const run = workflowRuns.workflow_runs[0];
+  if (!run) {
+    throw new Error(`No successful end2end workflow run found for commit ${tagCommit}`);
+  }
+  
+  core.info(`Found staging run: ${run.id} with conclusion: ${run.conclusion}`);
+  
+  // Construct artifacts name
+  const commitHash = tagCommit.substring(0, 7); // Use first 7 chars of commit hash
+  const buildNumber = run.run_number;
+  const artifactsName = `github:${context.repo.owner}:${context.repo.repo}:staging-${commitHash}.${workflow_id}.${buildNumber}`;
+  
+  core.info(`Auto-derived artifacts name: ${artifactsName}`);
+  return artifactsName;
+}
+
+module.exports = { getBuildArtifact };
+
+// For TypeScript imports
+if (typeof exports !== 'undefined') {
+  exports.getBuildArtifact = getBuildArtifact;
+}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -9,13 +9,15 @@ on:
         description: Tag
         required: true
       artifacts-name:
-        description: Artifacts name to promote
-        required: true
+        description: Artifacts name to promote (optional - will be auto-detected if not provided)
+        required: false
 
 jobs:
   verify-release:
     name: Verify if tag is valid
     runs-on: ubuntu-24.04
+    outputs:
+      artifacts-name: ${{ steps.get-artifacts-name.outputs.artifacts-name }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -42,6 +44,18 @@ jobs:
         run: |
           ! git show-ref --tags ${{ github.event.inputs.tag }} --quiet
 
+      - name: Auto-derive artifacts name if not provided
+        uses: actions/github-script@v7
+        id: get-artifacts-name
+        with:
+          script: |
+            const { getBuildArtifact } = require('./.github/scripts/get-build-artifact');
+            const artifactsName = process.env.ARTIFACTS_NAME
+                || await getBuildArtifact(github, context, core);
+            core.setOutput('artifacts-name', artifactsName);
+        env:
+          ARTIFACTS_NAME: ${{ github.event.inputs.artifacts-name }}
+
   release:
     name: Release
     runs-on: ubuntu-24.04
@@ -114,7 +128,7 @@ jobs:
       uses: scality/action-artifacts@v4
       with:
         method: promote
-        name: ${{ github.event.inputs.artifacts-name }}
+        name: ${{ needs.verify-release.outputs.artifacts-name }}
         tag: ${{ github.event.inputs.tag }}
         url: https://artifacts.scality.net
         user: ${{ secrets.ARTIFACTS_USER }}
diff --git a/tests/workflows/getBuildArtifact.spec.ts b/tests/workflows/getBuildArtifact.spec.ts
@@ -0,0 +1,149 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { getBuildArtifact } = require('../../.github/scripts/get-build-artifact');
+import * as sinon from 'sinon';
+
+describe('getBuildArtifact', () => {
+    let mockGithub: any;
+    let mockContext: any;
+    let mockCore: any;
+    let sandbox: sinon.SinonSandbox;
+
+    beforeEach(() => {
+        sandbox = sinon.createSandbox();
+        
+        // Create mock GitHub API client
+        mockGithub = {
+            rest: {
+                actions: {
+                    listWorkflowRuns: sandbox.stub()
+                }
+            }
+        };
+
+        mockContext = {
+            repo: {
+                owner: 'scality',
+                repo: 'zenko',
+            },
+            sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+        };
+
+        mockCore = {
+            info: sandbox.stub(),
+            exportVariable: sandbox.stub(),
+        };
+    });
+
+    afterEach(() => {
+        sandbox.restore();
+    });
+
+    it('should construct correct artifacts name from successful run', async () => {
+        mockGithub.rest.actions.listWorkflowRuns.resolves({
+            data: {
+                total_count: 1,
+                workflow_runs: [
+                    {
+                        id: 12345,
+                        name: 'build-iso-and-end2end-test',
+                        conclusion: 'success',
+                        run_number: 678,
+                        status: 'completed',
+                        head_sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+                        workflow_id: 1,
+                        url: 'https://api.github.com/repos/scality/zenko/actions/runs/12345',
+                        html_url: 'https://github.com/scality/zenko/actions/runs/12345',
+                        created_at: '2023-01-01T00:00:00Z',
+                        updated_at: '2023-01-01T00:00:00Z',
+                        run_started_at: '2023-01-01T00:00:00Z',
+                    },
+                ],
+            },
+        });
+
+        const result = await getBuildArtifact(mockGithub, mockContext, mockCore);
+        expect(result).toBe('github:scality:zenko:staging-abcd123.build-iso-and-end2end-test.678');
+
+        // Verify the API call was made with correct parameters
+        expect(mockGithub.rest.actions.listWorkflowRuns.calledOnce).toBe(true);
+        expect(mockGithub.rest.actions.listWorkflowRuns.calledWith({
+            owner: 'scality',
+            repo: 'zenko',
+            workflow_id: 'build-iso-and-end2end-test',
+            head_sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+            status: 'completed',
+            conclusion: 'success'
+        })).toBe(true);
+
+        // Verify logging calls
+        expect(mockCore.info.calledWith('Looking for successful builds for commit: abcd1234567890abcdef1234567890abcdefabcd')).toBe(true);
+        expect(mockCore.info.calledWith('Found staging run: 12345 with conclusion: success')).toBe(true);
+        expect(mockCore.info.calledWith('Auto-derived artifacts name: github:scality:zenko:staging-abcd123.build-iso-and-end2end-test.678')).toBe(true);
+    });
+
+    it('should fail when no staging workflow run is found', async () => {
+        mockGithub.rest.actions.listWorkflowRuns.resolves({
+            data: {
+                total_count: 0,
+                workflow_runs: [],
+            },
+        });
+
+        await expect(getBuildArtifact(mockGithub, mockContext, mockCore))
+            .rejects
+            .toThrow('No successful end2end workflow run found for commit abcd1234567890abcdef1234567890abcdefabcd');
+
+        // Verify the API call was made with correct parameters
+        expect(mockGithub.rest.actions.listWorkflowRuns.calledOnce).toBe(true);
+        expect(mockGithub.rest.actions.listWorkflowRuns.calledWith({
+            owner: 'scality',
+            repo: 'zenko',
+            workflow_id: 'build-iso-and-end2end-test',
+            head_sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+            status: 'completed',
+            conclusion: 'success'
+        })).toBe(true);
+    });
+
+    it('should handle workflow run with multiple workflows', async () => {
+        mockGithub.rest.actions.listWorkflowRuns.resolves({
+            data: {
+                total_count: 2,
+                workflow_runs: [
+                    {
+                        id: 56789,
+                        name: 'build-iso-and-end2end-test',
+                        conclusion: 'success',
+                        run_number: 999,
+                        status: 'completed',
+                        head_sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+                        url: 'https://api.github.com/repos/scality/zenko/actions/runs/56789',
+                        html_url: 'https://github.com/scality/zenko/actions/runs/56789',
+                        created_at: '2024-01-01T00:00:00Z',
+                        updated_at: '2024-01-01T00:00:00Z',
+                        run_started_at: '2024-01-01T00:00:00Z',
+                    },
+                    {
+                        id: 12345,
+                        name: 'build-iso-and-end2end-test',
+                        conclusion: 'success',
+                        run_number: 678,
+                        status: 'completed',
+                        head_sha: 'abcd1234567890abcdef1234567890abcdefabcd',
+                        workflow_id: 1,
+                        url: 'https://api.github.com/repos/scality/zenko/actions/runs/12345',
+                        html_url: 'https://github.com/scality/zenko/actions/runs/12345',
+                        created_at: '2023-01-01T00:00:00Z',
+                        updated_at: '2023-01-01T00:00:00Z',
+                        run_started_at: '2023-01-01T00:00:00Z',
+                    },
+                ],
+            },
+        });
+
+        const result = await getBuildArtifact(mockGithub, mockContext, mockCore);
+
+        expect(result).toBe('github:scality:zenko:staging-abcd123.build-iso-and-end2end-test.999');
+        expect(mockCore.info.calledWith('Found staging run: 56789 with conclusion: success')).toBe(true);
+    });
+});
diff --git a/tests/workflows/package.json b/tests/workflows/package.json
@@ -10,9 +10,12 @@
   "devDependencies": {
     "@kie/act-js": "^2.6.1",
     "@kie/mock-github": "^2.0.1",
+    "@octokit/rest": "^19.0.4",
     "@types/jest": "^29.1.2",
     "@types/node": "^18.8.5",
+    "@types/sinon": "^10.0.0",
     "jest": "^29.1.2",
+    "sinon": "^15.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "tsc": "^2.0.4",
diff --git a/tests/workflows/release.spec.ts b/tests/workflows/release.spec.ts
@@ -27,7 +27,13 @@ function withGitTag(tag: string, repo: string = 'zenko') {
 
 function withArtifact(artifactsName: string) {
     const f = () => act.setInput("artifacts-name", artifactsName);
-    f.toString = () => " and artifact " + artifactsName
+    f.toString = () => " and artifact " + artifactsName;
+    return f;
+}
+
+function withoutArtifact() {
+    const f = () => act.deleteInput("artifacts-name");
+    f.toString = () => " and no artifact";
     return f;
 }
 
@@ -138,6 +144,7 @@ test.each([
     ['Promote artifacts', Fail, '2.3.7-rc.1', withArtifact('github:scality:Zenko:staging-ac5768a8c6.build-iso-and-end2end-test.3454')],
     ['Promote artifacts', Pass, '2.3.7-rc.1', ''],
     ['Promote artifacts', Pass, '2.3.7', withVersionFile("VERSION-2.3.7")],
+    ['Promote artifacts', Pass, '2.3.7-rc.1', withoutArtifact()],
 ])("%s should %s when version is %s%s", async (stepName, status, tag, ...configs) => {
 
     for(var c of configs.filter(c => !!c)) {
@@ -162,6 +169,25 @@ test.each([
                 .setIndex()
                 .reply({ status: 200, data: "PASSED\n", repeat: 2 }),
 
+            // Mock automatic artifact discovery
+            moctokit.rest.actions
+                .listWorkflowRuns()
+                .reply({
+                    status: 200,
+                    data: {
+                        total_count: 1,
+                        workflow_runs: [{
+                            id: 1234,
+                            conclusion: "success",
+                            head_branch: "development/2.3",
+                            head_sha: await getCommitHash(),
+                            name: "build-iso-and-end2end-test",
+                            run_number: 3454,
+                            status: "completed",
+                        }],
+                    }
+                }),
+
             // Mock release notes generation
             moctokit.rest.repos
                 .listReleases()
diff --git a/tests/workflows/yarn.lock b/tests/workflows/yarn.lock
