wdio-test-ledger-service 9.2.4 → 9.2.6

package/.github/workflows/release.yml

@@ -1,6 +1,9 @@
 name: Publish to NPM
 
 on:
+  push:
+    branches:
+      - master
   workflow_dispatch:
     inputs:
       release_type:
@@ -25,6 +28,7 @@ jobs:
         with:
           ref: 'master'
           fetch-depth: 0
+
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
@@ -43,6 +47,16 @@ jobs:
       - name: Install Dependencies
         run: npm ci
 
-      - run: npm run release -- ${{ github.event.inputs.release_type }}
+      - name: Release (manual)
+        if: github.event_name == 'workflow_dispatch'
+        run: npm run release -- ${{ github.event.inputs.release_type }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Release (auto patch on push)
+        if: github.event_name == 'push'
+        run: npm run release -- patch
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.release-it.json

@@ -1,5 +1,13 @@
 {
   "npm": {
+    "publish": true,
     "skipChecks": true
+  },
+  "git": {
+    "commitMessage": "Release v${version}",
+    "tagName": "v${version}"
+  },
+  "github": {
+    "release": false
   }
 }

package/README.md

@@ -14,22 +14,35 @@ npm install wdio-test-ledger-service
 
 ## Add the service to the services array in wdio.conf.js
 
-```
+```javascript
 services: [['test-ledger', {
-	reporterOutputDir : `./testledger`,            // This must match the outputDir from the wdio-test-reporter
-	apiUrl            : `app-api.testledger.dev`,  // Defaults to app-api.testledger.dev if none is set
-	username          : `jenkins@foobar.com`,      // app.testledger.dev username
-	apiToken          : `12345`,                   // Found in the app.testledger.dev under your proifle section
+	reporterOutputDir : './testledger',            // This must match the outputDir from the wdio-test-reporter
+	apiUrl            : 'app-api.testledger.dev',  // Defaults to app-api.testledger.dev if none is set
+	apiToken          : 'tl_abc123_yoursecret',    // API token from app.testledger.dev
 	projectId         : 123,                       // Only needed if using more than one project
-	appVersion        : `2.8.10`,                  // The code version can also be set here
+	appVersion        : '2.8.10',                  // The code version can also be set here
 	enableFlaky       : 1,                         // Will mark tests as flaky if it detects them based on previous runs
 	uploadArtifacts   : true,                      // Enable screenshot/video artifact uploads
-	screenshotDir     : `./screenshots`,           // Directory containing screenshots
-	videoDir          : `./_results_/videos`,      // Directory containing videos (e.g. from wdio-video-reporter)
+	screenshotDir     : './screenshots',           // Directory containing screenshots
+	videoDir          : './_results_/videos',      // Directory containing videos (e.g. from wdio-video-reporter)
 }]],
 ```
 
-You will create a custom `username` and `apiToken` in the UI under Settings -> Profile -> API Keys
+You can create an API token in the UI under Settings -> Profile -> API Keys.
+
+**Tip:** Use the `TESTLEDGER_API_TOKEN` environment variable instead of hardcoding the token:
+
+```javascript
+services: [['test-ledger', {
+	reporterOutputDir : './testledger',
+	projectId         : 123,
+}]],
+```
+
+```bash
+export TESTLEDGER_API_TOKEN="tl_abc123_yoursecret"
+npx wdio run wdio.conf.js
+```
 
 ## Add the wdio-test-ledger-reporter to the reporters array in wdio.conf.js
 
@@ -70,8 +83,7 @@ reporters: [
 ],
 services: [['test-ledger', {
 	reporterOutputDir : './testledger',
-	username          : 'your-email@example.com',
-	apiToken          : 'your-api-token',
+	apiToken          : 'tl_abc123_yoursecret',  // Or use TESTLEDGER_API_TOKEN env var
 	uploadArtifacts   : true,
 	screenshotDir     : './screenshots',
 	videoDir          : './_results_/videos'
@@ -82,8 +94,9 @@ Artifacts are matched to test suites based on filename. The service looks for th
 
 ## Environment variables
 
-Environment variables can be set when running tests that the server will use to add to the results
+Environment variables can be set when running tests:
 
+* `TESTLEDGER_API_TOKEN` - API token for authentication (recommended for CI)
 * `RUN_TITLE`    - Title of the test run. This might be something like a Jira issue key. Defaults to a timestamp if not specified
-* `RUN_UUID`     - UUID which can be used to directly link to the test run results. e.g. https://app.testledger.dev/runs/c26b23d8-eb9f-4ff4-a884-5cb9f3d3aba5<uuid>
+* `RUN_UUID`     - UUID which can be used to directly link to the test run results. e.g. https://app.testledger.dev/runs/<uuid>
 * `APP_VERSION`  - Set the version of app this test run ran against

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-test-ledger-service",
-  "version": "9.2.4",
+  "version": "9.2.6",
   "description": "WebdriverIO server to send reporter data to testledger.dev",
   "type": "module",
   "main": "src/index.js",
@@ -8,7 +8,7 @@
     "node": "20.x"
   },
   "scripts": {
-    "release": "release-it --github.release"
+    "release": "release-it"
   },
   "repository": {
     "type": "git",
@@ -31,7 +31,6 @@
   },
   "homepage": "https://github.com/WillBrock/wdio-test-ledger-service#readme",
   "dependencies": {
-    "btoa": "^1.2.1",
     "fs-extra": "^11.2.0",
     "node-fetch": "^3.3.2"
   },

package/src/index.js

@@ -1,6 +1,5 @@
 import fs   from 'fs-extra';
 import path from 'path';
-import btoa from 'btoa';
 import { SevereServiceError } from 'webdriverio';
 
 const api_url = `https://app-api.testledger.dev`;
@@ -25,12 +24,11 @@ class TestLedgerLauncher {
 			throw new SevereServiceError(`No reporterOutputDir specified`)
 		}
 
-		if(!this.options.username) {
-			throw new SevereServiceError(`No username specified`)
-		}
+		// Support env var with fallback to option
+		this.apiToken = process.env.TESTLEDGER_API_TOKEN || this.options.apiToken;
 
-		if(!this.options.apiToken) {
-			throw new SevereServiceError(`No apiToken specified`)
+		if(!this.apiToken) {
+			throw new SevereServiceError(`No apiToken specified. Set TESTLEDGER_API_TOKEN env var or pass apiToken option.`)
 		}
 
 		// Artifact upload options
@@ -201,7 +199,7 @@ class TestLedgerLauncher {
 			method  : `POST`,
 			headers : {
 				'Content-Type'  : `application/json`,
-				'Authorization' : `Basic ${this.getAuthToken()}`,
+				'Authorization' : this.getAuthHeader(),
 			},
 			body : JSON.stringify(data),
 		});
@@ -218,11 +216,8 @@ class TestLedgerLauncher {
 		].join(``);
 	}
 
-	getAuthToken() {
-		return btoa([
-			this.options.username,
-			this.options.apiToken,
-		].join(`:`));
+	getAuthHeader() {
+		return `Bearer ${this.apiToken}`;
 	}
 
 	/**
@@ -414,7 +409,7 @@ class TestLedgerLauncher {
 			method  : 'POST',
 			headers : {
 				'Content-Type'  : 'application/json',
-				'Authorization' : `Basic ${this.getAuthToken()}`
+				'Authorization' : this.getAuthHeader()
 			},
 			body : JSON.stringify(payload)
 		});
@@ -477,7 +472,7 @@ class TestLedgerLauncher {
 			method  : 'POST',
 			headers : {
 				'Content-Type'  : 'application/json',
-				'Authorization' : `Basic ${this.getAuthToken()}`
+				'Authorization' : this.getAuthHeader()
 			},
 			body : JSON.stringify({ artifact_ids: artifact_ids })
 		});