gha-workflow-testing 1.0.0 → 1.0.1

package/README.md

@@ -12,21 +12,10 @@ TypeScript library for testing GitHub Actions workflows with detailed reporting
 
 ## Installation
 
-### Option 1: Via Git (Immediate - No setup required)
-
 ```bash
-npm install git+https://github.com/global-data-analytics/dops-gha-tests.git
+npm install npm i gha-workflow-testing
 ```
 
-### 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
 
@@ -40,7 +29,7 @@ export GITHUB_REPOSITORY="owner/repo"
 ### 2. Write Tests
 
 ```typescript
-import { GitHubAPI, assertJobSuccess, getReporter } from '@global-data-analytics/gha-test';
+import { GitHubAPI, assertJobSuccess, getReporter } from 'gha-workflow-testing';
 
 const WORKFLOW_NAME = 'CI Workflow';
 
@@ -109,6 +98,15 @@ const artifacts = await api.getArtifacts(runId);
 
 Functions for testing workflow components.
 
+| Function | Parameters | Description |
+|----------|------------|-------------|
+| `assertJobSuccess` | `jobs`, `jobName`, `reporter`, `expectedConclusion?` | Assert a job completed with the expected conclusion (default: 'success') |
+| `assertStepSuccess` | `steps`, `stepName`, `jobName`, `reporter`, `expectedConclusion?` | Assert a step completed with the expected conclusion (default: 'success') |
+| `assertArtifactExists` | `artifacts`, `artifactName`, `reporter` | Assert that an artifact was uploaded in the workflow run |
+| `assertJFrogArtifactExists` | `options`, `reporter` | Assert that an artifact exists in JFrog Artifactory |
+
+#### Usage Examples
+
 ```typescript
 // Assert job completed with expected conclusion
 assertJobSuccess(jobs, 'job-name', reporter, 'success');
@@ -121,9 +119,9 @@ assertArtifactExists(artifacts, 'artifact-name', reporter);
 
 // Assert JFrog artifact exists
 await assertJFrogArtifactExists({
-  jfrogUrl: 'https://mcd.jfrog.io',
-  repository: 'gdap-docker-dev',
-  artifactPath: 'dops/your-app',
+  jfrogUrl: 'URL',
+  repository: 'REPO_NAME',
+  artifactPath: 'apps/your-app',
   artifactName: 'dev',
   jfrogToken: process.env.JFROG_TOKEN,
   reporter,
@@ -199,11 +197,10 @@ npm run build
 | `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.
+- TBA
 
 ## License
 
@@ -211,4 +208,4 @@ MIT
 
 ## Maintainers
 
-DOPS Team - Data Operations & Platform Services
+Rohit Patil

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gha-workflow-testing",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "TypeScript library for testing GitHub Actions workflows with detailed reporting",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,10 +17,9 @@
     "workflow",
     "testing",
     "ci-cd",
-    "typescript",
-    "dops"
+    "typescript"
   ],
-  "author": "DOPS Team",
+  "author": "Rohit Patil",
   "license": "MIT",
   "files": [
     "dist",