gha-workflow-testing 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 global-data-analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,214 @@
+# @global-data-analytics/gha-test
+
+TypeScript library for testing GitHub Actions workflows with detailed reporting and assertions.
+
+## Features
+
+- 🔍 **GitHub API Integration** - Fetch workflow runs, jobs, steps, and artifacts
+- ✅ **Rich Assertions** - Test jobs, steps, artifacts, and JFrog deployments
+- 📊 **Detailed Reporting** - Generate markdown reports for GitHub Actions summaries
+- 🎯 **Type-Safe** - Full TypeScript support with type definitions
+- 🧪 **Jest Integration** - Works seamlessly with Jest testing framework
+
+## Installation
+
+### Option 1: Via Git (Immediate - No setup required)
+
+```bash
+npm install git+https://github.com/global-data-analytics/dops-gha-tests.git
+```
+
+### Option 2: Via GitHub Packages (Coming soon)
+
+```bash
+# Configure .npmrc
+echo "@global-data-analytics:registry=https://npm.pkg.github.com" >> .npmrc
+
+# Install
+npm install @global-data-analytics/gha-test
+```
+
+## Quick Start
+
+### 1. Set Environment Variables
+
+```bash
+export GITHUB_TOKEN="your-github-token"
+export GITHUB_REPOSITORY="owner/repo"
+```
+
+### 2. Write Tests
+
+```typescript
+import { GitHubAPI, assertJobSuccess, getReporter } from '@global-data-analytics/gha-test';
+
+const WORKFLOW_NAME = 'CI Workflow';
+
+describe('CI Workflow Tests', () => {
+  let api: GitHubAPI;
+  let runId: number;
+
+  beforeAll(async () => {
+    api = new GitHubAPI();
+    const reporter = getReporter(WORKFLOW_NAME);
+
+    runId = await api.getLatestRun(WORKFLOW_NAME);
+    reporter.setRunId(runId);
+
+    // Load all jobs and steps for comprehensive reporting
+    await reporter.loadAllJobsAndSteps(api);
+  });
+
+  afterAll(() => {
+    const reporter = getReporter();
+    reporter.writeToGithubSummary();
+    reporter.printReport();
+  });
+
+  it('should complete build job', async () => {
+    const reporter = getReporter();
+    const jobs = await api.getJobs(runId);
+
+    assertJobSuccess(jobs, 'build', reporter, 'success');
+  });
+});
+```
+
+### 3. Run Tests
+
+```bash
+npm test
+```
+
+## API Reference
+
+### GitHubAPI
+
+Class for interacting with the GitHub API.
+
+```typescript
+const api = new GitHubAPI();
+
+// Get latest workflow run
+const runId = await api.getLatestRun('My Workflow');
+
+// Get jobs in a run
+const jobs = await api.getJobs(runId);
+
+// Wait for jobs to complete (optional - usually not needed with workflow_run trigger)
+await api.waitForJobsCompletion(runId, timeout, pollInterval);
+
+// Get steps in a job
+const steps = await api.getSteps(runId, 'job-name');
+
+// Get artifacts
+const artifacts = await api.getArtifacts(runId);
+```
+
+### Assertions
+
+Functions for testing workflow components.
+
+```typescript
+// Assert job completed with expected conclusion
+assertJobSuccess(jobs, 'job-name', reporter, 'success');
+
+// Assert step completed successfully
+assertStepSuccess(steps, 'step-name', 'job-name', reporter, 'success');
+
+// Assert artifact exists
+assertArtifactExists(artifacts, 'artifact-name', reporter);
+
+// Assert JFrog artifact exists
+await assertJFrogArtifactExists({
+  jfrogUrl: 'https://mcd.jfrog.io',
+  repository: 'gdap-docker-dev',
+  artifactPath: 'dops/your-app',
+  artifactName: 'dev',
+  jfrogToken: process.env.JFROG_TOKEN,
+  reporter,
+});
+```
+
+### Reporter
+
+Class for generating test reports.
+
+```typescript
+const reporter = getReporter('Workflow Name');
+
+// Set run ID
+reporter.setRunId(runId);
+
+// Load all jobs and steps for complete visibility
+await reporter.loadAllJobsAndSteps(api);
+
+// Record test results (done automatically by assertions)
+reporter.recordJobTest('job-name', true, 'success', 'success');
+reporter.recordStepTest('job-name', 'step-name', true, 'success', 'success');
+reporter.recordArtifactTest('artifact-name', 'exists', true, 'expected');
+
+// Generate and write report
+reporter.writeToGithubSummary(); // Write to GitHub Actions summary
+reporter.printReport(); // Print to console
+```
+
+## Project Structure
+
+```
+dops-gha-tests/
+├── src/
+│   ├── github-api.ts      # GitHub API client
+│   ├── assertions.ts      # Test assertions
+│   ├── reporter.ts        # Test reporter
+│   └── index.ts           # Main exports
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## Building
+
+```bash
+npm run build
+```
+
+This will compile TypeScript to JavaScript in the `dist/` directory.
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Lint code
+npm run lint
+
+# Format code
+npm run format
+
+# Build
+npm run build
+```
+
+## Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `GITHUB_TOKEN` | Yes | GitHub API token with workflow read access |
+| `GITHUB_REPOSITORY` | Yes | Repository in `owner/repo` format |
+| `GITHUB_STEP_SUMMARY` | No | Path to GitHub Actions summary file (auto-set in CI) |
+| `JFROG_TOKEN` | No | JFrog access token for artifact verification |
+| `GDAP_ARTIFACTORY_ACCESS_TOKEN` | No | Alternative JFrog token |
+
+## Example Usage
+
+See [dops-testing](https://github.com/global-data-analytics/dops-testing) repository for complete examples of how to use this library.
+
+## License
+
+MIT
+
+## Maintainers
+
+DOPS Team - Data Operations & Platform Services

package/dist/assertions.d.ts

@@ -0,0 +1,23 @@
+import { Jobs, Steps, Artifacts } from './github-api';
+import { WorkflowTestReporter } from './reporter';
+export declare function assertJobSuccess(jobs: Jobs, jobName: string, reporter?: WorkflowTestReporter, expectedConclusion?: string): void;
+export declare function assertStepSuccess(steps: Steps, stepName: string, jobName?: string, reporter?: WorkflowTestReporter, expectedConclusion?: string): void;
+export declare function assertArtifactExists(artifacts: Artifacts, artifactName: string, reporter?: WorkflowTestReporter): void;
+export declare function assertFileInArtifact(artifactFiles: {
+    [filename: string]: Buffer;
+}, filename: string, artifactName?: string, reporter?: WorkflowTestReporter): void;
+export declare function assertFileContains(artifactFiles: {
+    [filename: string]: Buffer;
+}, filename: string, expectedContent: string | Buffer, artifactName?: string, reporter?: WorkflowTestReporter): void;
+export interface JFrogArtifactOptions {
+    jfrogUrl: string;
+    repository: string;
+    artifactPath: string;
+    artifactName: string;
+    jfrogApiKey?: string;
+    jfrogToken?: string;
+    reporter?: WorkflowTestReporter;
+    jobName?: string;
+}
+export declare function assertJFrogArtifactExists(options: JFrogArtifactOptions): Promise<void>;
+//# sourceMappingURL=assertions.d.ts.map

package/dist/assertions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.d.ts","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,kBAAkB,GAAE,MAAkB,GACrC,IAAI,CA2CN;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,kBAAkB,GAAE,MAAkB,GACrC,IAAI,CAkCN;AAED,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,IAAI,CAmCN;AAED,wBAAgB,oBAAoB,CAClC,aAAa,EAAE;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,IAAI,CAmCN;AAED,wBAAgB,kBAAkB,CAChC,aAAa,EAAE;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GAAG,MAAM,EAChC,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,IAAI,CAsDN;AAMD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAgIf"}

package/dist/assertions.js

@@ -0,0 +1,260 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertJobSuccess = assertJobSuccess;
+exports.assertStepSuccess = assertStepSuccess;
+exports.assertArtifactExists = assertArtifactExists;
+exports.assertFileInArtifact = assertFileInArtifact;
+exports.assertFileContains = assertFileContains;
+exports.assertJFrogArtifactExists = assertJFrogArtifactExists;
+const axios_1 = __importDefault(require("axios"));
+function assertJobSuccess(jobs, jobName, reporter, expectedConclusion = 'success') {
+    try {
+        if (!jobs[jobName]) {
+            const availableJobs = Object.keys(jobs).join('\n  - ');
+            throw new Error(`${jobName} not found. Available jobs:\n  - ${availableJobs}`);
+        }
+        const jobInfo = jobs[jobName];
+        const { status, conclusion } = jobInfo;
+        if (conclusion !== expectedConclusion) {
+            if (conclusion === null) {
+                throw new Error(`${jobName} did not complete with expected conclusion '${expectedConclusion}'.\n` +
+                    `  Status: ${status}\n` +
+                    `  Conclusion: ${conclusion} (job was skipped, cancelled, or still running)`);
+            }
+            else {
+                throw new Error(`${jobName} did not have expected conclusion.\n` +
+                    `  Expected: ${expectedConclusion}\n` +
+                    `  Actual: ${conclusion}\n` +
+                    `  Status: ${status}`);
+            }
+        }
+        console.log(`✅ ${jobName} completed with conclusion '${expectedConclusion}'`);
+        // Record success in reporter
+        if (reporter) {
+            reporter.recordJobTest(jobName, true, expectedConclusion, conclusion);
+        }
+    }
+    catch (error) {
+        // Record failure in reporter
+        if (reporter) {
+            const conclusion = jobs[jobName]?.conclusion || 'unknown';
+            reporter.recordJobTest(jobName, false, expectedConclusion, conclusion);
+        }
+        throw error;
+    }
+}
+function assertStepSuccess(steps, stepName, jobName, reporter, expectedConclusion = 'success') {
+    try {
+        if (!steps[stepName]) {
+            const availableSteps = Object.keys(steps).join('\n  - ');
+            throw new Error(`Step '${stepName}' not found. Available steps:\n  - ${availableSteps}`);
+        }
+        const stepInfo = steps[stepName];
+        const { conclusion } = stepInfo;
+        if (conclusion !== expectedConclusion) {
+            throw new Error(`Step '${stepName}' did not have expected conclusion.\n` +
+                `  Expected: ${expectedConclusion}\n` +
+                `  Actual: ${conclusion}`);
+        }
+        console.log(`✅ Step '${stepName}' completed with conclusion '${expectedConclusion}'`);
+        // Record success in reporter
+        if (reporter && jobName) {
+            reporter.recordStepTest(jobName, stepName, true, expectedConclusion, conclusion || undefined);
+        }
+    }
+    catch (error) {
+        // Record failure in reporter
+        if (reporter && jobName) {
+            const conclusion = steps[stepName]?.conclusion || 'unknown';
+            reporter.recordStepTest(jobName, stepName, false, expectedConclusion, conclusion || undefined);
+        }
+        throw error;
+    }
+}
+function assertArtifactExists(artifacts, artifactName, reporter) {
+    try {
+        if (!artifacts[artifactName]) {
+            const availableArtifacts = Object.keys(artifacts).length > 0
+                ? Object.keys(artifacts).join('\n  - ')
+                : '(no artifacts)';
+            throw new Error(`Artifact '${artifactName}' not found. Available artifacts:\n  - ${availableArtifacts}`);
+        }
+        const artifactInfo = artifacts[artifactName];
+        if (artifactInfo.expired) {
+            throw new Error(`Artifact '${artifactName}' has expired`);
+        }
+        console.log(`✅ Artifact '${artifactName}' exists (size: ${artifactInfo.size} bytes)`);
+        // Record success in reporter
+        if (reporter) {
+            reporter.recordArtifactTest(artifactName, 'exists', true, 'exists');
+        }
+    }
+    catch (error) {
+        // Record failure in reporter
+        if (reporter) {
+            reporter.recordArtifactTest(artifactName, 'exists', false, 'exists', 'not found or expired');
+        }
+        throw error;
+    }
+}
+function assertFileInArtifact(artifactFiles, filename, artifactName, reporter) {
+    try {
+        if (!artifactFiles[filename]) {
+            const availableFiles = Object.keys(artifactFiles).length > 0
+                ? Object.keys(artifactFiles).join('\n  - ')
+                : '(no files)';
+            throw new Error(`File '${filename}' not found in artifact. Available files:\n  - ${availableFiles}`);
+        }
+        console.log(`✅ File '${filename}' found in artifact`);
+        // Record success in reporter
+        if (reporter && artifactName) {
+            reporter.recordArtifactTest(artifactName, `file '${filename}' exists`, true, filename);
+        }
+    }
+    catch (error) {
+        // Record failure in reporter
+        if (reporter && artifactName) {
+            reporter.recordArtifactTest(artifactName, `file '${filename}' exists`, false, filename, 'not found');
+        }
+        throw error;
+    }
+}
+function assertFileContains(artifactFiles, filename, expectedContent, artifactName, reporter) {
+    try {
+        assertFileInArtifact(artifactFiles, filename, artifactName, reporter);
+        const fileContent = artifactFiles[filename];
+        const expectedBuffer = typeof expectedContent === 'string'
+            ? Buffer.from(expectedContent)
+            : expectedContent;
+        if (!fileContent.includes(expectedBuffer)) {
+            const contentStr = typeof expectedContent === 'string'
+                ? expectedContent
+                : expectedContent.toString();
+            throw new Error(`File '${filename}' does not contain expected content: ${contentStr}`);
+        }
+        console.log(`✅ File '${filename}' contains expected content`);
+        // Record success in reporter
+        if (reporter && artifactName) {
+            const contentPreview = (typeof expectedContent === 'string'
+                ? expectedContent
+                : expectedContent.toString()).substring(0, 50);
+            reporter.recordArtifactTest(artifactName, `file '${filename}' contains content`, true, contentPreview);
+        }
+    }
+    catch (error) {
+        // Record failure in reporter
+        if (reporter && artifactName) {
+            const contentPreview = (typeof expectedContent === 'string'
+                ? expectedContent
+                : expectedContent.toString()).substring(0, 50);
+            reporter.recordArtifactTest(artifactName, `file '${filename}' contains content`, false, contentPreview, 'not found');
+        }
+        throw error;
+    }
+}
+async function assertJFrogArtifactExists(options) {
+    const { jfrogUrl, repository, artifactPath, artifactName, jfrogApiKey, jfrogToken, reporter, } = options;
+    // Create artifact display name for reporter
+    const jfrogArtifactDisplayName = `JFrog: ${repository}/${artifactPath}/${artifactName}`;
+    try {
+        // Get credentials from parameters or environment
+        const apiKey = jfrogApiKey || process.env.MCD_ACTIONS_DD_API_KEY;
+        const token = jfrogToken || process.env.GDAP_ARTIFACTORY_ACCESS_TOKEN;
+        if (!apiKey && !token) {
+            throw new Error('JFrog credentials not provided. Set one of:\n' +
+                '  - JFROG_API_KEY or GDAP_ARTIFACTORY_ACCESS_TOKEN environment variable\n' +
+                '  - JFROG_TOKEN environment variable\n' +
+                '  - Pass jfrogApiKey or jfrogToken parameter');
+        }
+        // Build artifact URL
+        const cleanJfrogUrl = jfrogUrl.replace(/\/$/, '');
+        const cleanArtifactPath = artifactPath.replace(/^\/|\/$/g, '');
+        const artifactUrl = `${cleanJfrogUrl}/artifactory/${repository}/${cleanArtifactPath}/${artifactName}`;
+        // Set up authentication headers
+        const headers = {};
+        let authMethod;
+        if (apiKey) {
+            headers['X-JFrog-Art-Api'] = apiKey;
+            authMethod = 'API Key';
+        }
+        else {
+            headers['Authorization'] = `Bearer ${token}`;
+            authMethod = 'Bearer Token';
+        }
+        console.log('🔍 Checking JFrog artifact existence...');
+        console.log(`   URL: ${artifactUrl}`);
+        console.log(`   Auth: ${authMethod}`);
+        // Make HEAD request to check if artifact exists
+        const response = await axios_1.default.head(artifactUrl, {
+            headers,
+            timeout: 30000,
+            maxRedirects: 5,
+        });
+        if (response.status === 200) {
+            // Artifact exists! Get metadata from response headers
+            const fileSize = response.headers['content-length'] || 'unknown';
+            const checksumSha1 = response.headers['x-checksum-sha1'] || 'N/A';
+            const lastModified = response.headers['last-modified'] || 'N/A';
+            console.log(`✅ Artifact '${artifactName}' exists in JFrog Artifactory`);
+            console.log(`   Repository: ${repository}`);
+            console.log(`   Path: ${artifactPath}`);
+            console.log(`   Size: ${fileSize} bytes`);
+            console.log(`   SHA1: ${checksumSha1}`);
+            console.log(`   Last Modified: ${lastModified}`);
+            // Record success in reporter as artifact
+            if (reporter) {
+                reporter.recordArtifactTest(jfrogArtifactDisplayName, 'exists in JFrog', true, `Size: ${fileSize} bytes, SHA1: ${checksumSha1.substring(0, 8)}...`);
+            }
+        }
+    }
+    catch (error) {
+        let errorMsg;
+        if (axios_1.default.isAxiosError(error)) {
+            if (error.response?.status === 404) {
+                errorMsg =
+                    `❌ Artifact '${artifactName}' not found in JFrog Artifactory.\n` +
+                        `   Repository: ${repository}\n` +
+                        `   Path: ${artifactPath}\n` +
+                        `   Status: 404 Not Found`;
+            }
+            else if (error.response?.status === 401) {
+                errorMsg =
+                    `❌ Authentication failed when checking JFrog artifact.\n` +
+                        `   Status: 401 Unauthorized`;
+            }
+            else if (error.response?.status === 403) {
+                errorMsg =
+                    `❌ Permission denied when checking JFrog artifact.\n` +
+                        `   Status: 403 Forbidden`;
+            }
+            else if (error.code === 'ECONNREFUSED' || error.code === 'ENOTFOUND') {
+                errorMsg =
+                    `❌ Failed to connect to JFrog Artifactory.\n` +
+                        `   Error: Connection error`;
+            }
+            else if (error.code === 'ETIMEDOUT' || error.code === 'ECONNABORTED') {
+                errorMsg =
+                    `❌ Request to JFrog Artifactory timed out.\n` +
+                        `   Timeout: 30 seconds`;
+            }
+            else {
+                errorMsg =
+                    `❌ Unexpected response when checking JFrog artifact.\n` +
+                        `   Status: ${error.response?.status}\n` +
+                        `   Error: ${error.message}`;
+            }
+        }
+        else {
+            errorMsg = `❌ Error checking JFrog artifact: ${error.message}`;
+        }
+        // Record failure in reporter
+        if (reporter) {
+            reporter.recordArtifactTest(jfrogArtifactDisplayName, 'exists in JFrog', false, 'artifact exists', 'not found or error');
+        }
+        throw new Error(errorMsg);
+    }
+}
+//# sourceMappingURL=assertions.js.map

package/dist/assertions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.js","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":";;;;;AAIA,4CAgDC;AAED,8CAwCC;AAED,oDAuCC;AAED,oDAwCC;AAED,gDA4DC;AAiBD,8DAkIC;AAlYD,kDAA0B;AAI1B,SAAgB,gBAAgB,CAC9B,IAAU,EACV,OAAe,EACf,QAA+B,EAC/B,qBAA6B,SAAS;IAEtC,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACnB,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,oCAAoC,aAAa,EAAE,CAC9D,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9B,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAEvC,IAAI,UAAU,KAAK,kBAAkB,EAAE,CAAC;YACtC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,+CAA+C,kBAAkB,MAAM;oBAC/E,aAAa,MAAM,IAAI;oBACvB,iBAAiB,UAAU,iDAAiD,CAC/E,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,sCAAsC;oBAC9C,eAAe,kBAAkB,IAAI;oBACrC,aAAa,UAAU,IAAI;oBAC3B,aAAa,MAAM,EAAE,CACxB,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,KAAK,OAAO,+BAA+B,kBAAkB,GAAG,CAAC,CAAC;QAE9E,6BAA6B;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6BAA6B;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,IAAI,SAAS,CAAC;YAC1D,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAC/B,KAAY,EACZ,QAAgB,EAChB,OAAgB,EAChB,QAA+B,EAC/B,qBAA6B,SAAS;IAEtC,IAAI,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,SAAS,QAAQ,sCAAsC,cAAc,EAAE,CACxE,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;QAEhC,IAAI,UAAU,KAAK,kBAAkB,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CACb,SAAS,QAAQ,uCAAuC;gBACtD,eAAe,kBAAkB,IAAI;gBACrC,aAAa,UAAU,EAAE,CAC5B,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,gCAAgC,kBAAkB,GAAG,CAAC,CAAC;QAEtF,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,kBAAkB,EAAE,UAAU,IAAI,SAAS,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,UAAU,IAAI,SAAS,CAAC;YAC5D,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,kBAAkB,EAAE,UAAU,IAAI,SAAS,CAAC,CAAC;QACjG,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB,CAClC,SAAoB,EACpB,YAAoB,EACpB,QAA+B;IAE/B,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;YAC7B,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC;gBAC1D,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACvC,CAAC,CAAC,gBAAgB,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,aAAa,YAAY,0CAA0C,kBAAkB,EAAE,CACxF,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAC7C,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,aAAa,YAAY,eAAe,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,eAAe,YAAY,mBAAmB,YAAY,CAAC,IAAI,SAAS,CAAC,CAAC;QAEtF,6BAA6B;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6BAA6B;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,kBAAkB,CACzB,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,sBAAsB,CACvB,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB,CAClC,aAA6C,EAC7C,QAAgB,EAChB,YAAqB,EACrB,QAA+B;IAE/B,IAAI,CAAC;QACH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC;gBAC1D,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC3C,CAAC,CAAC,YAAY,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,SAAS,QAAQ,kDAAkD,cAAc,EAAE,CACpF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,qBAAqB,CAAC,CAAC;QAEtD,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;YAC7B,QAAQ,CAAC,kBAAkB,CACzB,YAAY,EACZ,SAAS,QAAQ,UAAU,EAC3B,IAAI,EACJ,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;YAC7B,QAAQ,CAAC,kBAAkB,CACzB,YAAY,EACZ,SAAS,QAAQ,UAAU,EAC3B,KAAK,EACL,QAAQ,EACR,WAAW,CACZ,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAgB,kBAAkB,CAChC,aAA6C,EAC7C,QAAgB,EAChB,eAAgC,EAChC,YAAqB,EACrB,QAA+B;IAE/B,IAAI,CAAC;QACH,oBAAoB,CAAC,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAEtE,MAAM,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,cAAc,GAClB,OAAO,eAAe,KAAK,QAAQ;YACjC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YAC9B,CAAC,CAAC,eAAe,CAAC;QAEtB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC1C,MAAM,UAAU,GACd,OAAO,eAAe,KAAK,QAAQ;gBACjC,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,SAAS,QAAQ,wCAAwC,UAAU,EAAE,CACtE,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,6BAA6B,CAAC,CAAC;QAE9D,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CACrB,OAAO,eAAe,KAAK,QAAQ;gBACjC,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAC/B,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,QAAQ,CAAC,kBAAkB,CACzB,YAAY,EACZ,SAAS,QAAQ,oBAAoB,EACrC,IAAI,EACJ,cAAc,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6BAA6B;QAC7B,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CACrB,OAAO,eAAe,KAAK,QAAQ;gBACjC,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAC/B,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,QAAQ,CAAC,kBAAkB,CACzB,YAAY,EACZ,SAAS,QAAQ,oBAAoB,EACrC,KAAK,EACL,cAAc,EACd,WAAW,CACZ,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAiBM,KAAK,UAAU,yBAAyB,CAC7C,OAA6B;IAE7B,MAAM,EACJ,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACV,QAAQ,GACT,GAAG,OAAO,CAAC;IAEZ,4CAA4C;IAC5C,MAAM,wBAAwB,GAAG,UAAU,UAAU,IAAI,YAAY,IAAI,YAAY,EAAE,CAAC;IAExF,IAAI,CAAC;QACH,iDAAiD;QACjD,MAAM,MAAM,GAAG,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;QACjE,MAAM,KAAK,GAAG,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;QAEtE,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,+CAA+C;gBAC7C,2EAA2E;gBAC3E,wCAAwC;gBACxC,8CAA8C,CACjD,CAAC;QACJ,CAAC;QAED,qBAAqB;QACrB,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,GAAG,aAAa,gBAAgB,UAAU,IAAI,iBAAiB,IAAI,YAAY,EAAE,CAAC;QAEtG,gCAAgC;QAChC,MAAM,OAAO,GAA8B,EAAE,CAAC;QAC9C,IAAI,UAAkB,CAAC;QAEvB,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC;YACpC,UAAU,GAAG,SAAS,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,KAAK,EAAE,CAAC;YAC7C,UAAU,GAAG,cAAc,CAAC;QAC9B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,WAAW,WAAW,EAAE,CAAC,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,EAAE,CAAC,CAAC;QAEtC,gDAAgD;QAChD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,WAAW,EAAE;YAC7C,OAAO;YACP,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,sDAAsD;YACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC;YACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC;YAClE,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC;YAEhE,OAAO,CAAC,GAAG,CAAC,eAAe,YAAY,+BAA+B,CAAC,CAAC;YACxE,OAAO,CAAC,GAAG,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,YAAY,YAAY,EAAE,CAAC,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,QAAQ,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,YAAY,YAAY,EAAE,CAAC,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAC;YAEjD,yCAAyC;YACzC,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,kBAAkB,CACzB,wBAAwB,EACxB,iBAAiB,EACjB,IAAI,EACJ,SAAS,QAAQ,iBAAiB,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CACpE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,IAAI,QAAgB,CAAC;QAErB,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBACnC,QAAQ;oBACN,eAAe,YAAY,qCAAqC;wBAChE,kBAAkB,UAAU,IAAI;wBAChC,YAAY,YAAY,IAAI;wBAC5B,0BAA0B,CAAC;YAC/B,CAAC;iBAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1C,QAAQ;oBACN,yDAAyD;wBACzD,6BAA6B,CAAC;YAClC,CAAC;iBAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1C,QAAQ;oBACN,qDAAqD;wBACrD,0BAA0B,CAAC;YAC/B,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBACvE,QAAQ;oBACN,6CAA6C;wBAC7C,4BAA4B,CAAC;YACjC,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACvE,QAAQ;oBACN,6CAA6C;wBAC7C,wBAAwB,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,QAAQ;oBACN,uDAAuD;wBACvD,cAAc,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI;wBACxC,aAAa,KAAK,CAAC,OAAO,EAAE,CAAC;YACjC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC;QACjE,CAAC;QAED,6BAA6B;QAC7B,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,kBAAkB,CACzB,wBAAwB,EACxB,iBAAiB,EACjB,KAAK,EACL,iBAAiB,EACjB,oBAAoB,CACrB,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC"}

package/dist/github-api.d.ts

@@ -0,0 +1,38 @@
+export interface JobInfo {
+    status: string;
+    conclusion: string | null;
+}
+export interface Jobs {
+    [jobName: string]: JobInfo;
+}
+export interface StepInfo {
+    conclusion: string | null;
+    number: number;
+}
+export interface Steps {
+    [stepName: string]: StepInfo;
+}
+export interface ArtifactInfo {
+    id: number;
+    size: number;
+    expired: boolean;
+    url: string;
+}
+export interface Artifacts {
+    [artifactName: string]: ArtifactInfo;
+}
+export declare class GitHubAPI {
+    private repo;
+    private client;
+    constructor();
+    getLatestRun(workflowName: string): Promise<number>;
+    getJobs(runId: number): Promise<Jobs>;
+    waitForJobsCompletion(runId: number, timeout?: number, pollInterval?: number): Promise<Jobs>;
+    getSteps(runId: number, jobName: string): Promise<Steps>;
+    getArtifacts(runId: number): Promise<Artifacts>;
+    downloadArtifact(artifactId: number): Promise<{
+        [filename: string]: Buffer;
+    }>;
+    private sleep;
+}
+//# sourceMappingURL=github-api.d.ts.map

package/dist/github-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"github-api.d.ts","sourceRoot":"","sources":["../src/github-api.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAI;IACnB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,KAAK;IACpB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC9B;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,CAAC;CACtC;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAgB;;IAqBxB,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnD,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBrC,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,MAAY,EACrB,YAAY,GAAE,MAAW,GACxB,OAAO,CAAC,IAAI,CAAC;IAyBV,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAwBxD,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAqB/C,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAcnF,OAAO,CAAC,KAAK;CAGd"}