@qawolf/ci-sdk 0.10.1 → 0.10.3

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.10.3
+
+_No visible changes_
+
+# v0.10.2
+
+- Avoid logging dots after URL names in the logs. Dots can confuse terminal
+  URL detection.
+
+# v0.10.1
+
+- Fix TypeScript types visibility.
+
 # v0.10.0
 
 Initial release.

package/README.md

@@ -26,12 +26,12 @@ const deployConfig: DeployConfig = {
   variables: undefined,
 };
 
-const { attemptDeploy } = makeQaWolfSdk({
+const { attemptNotifyDeploy } = makeQaWolfSdk({
   apiKey: "qawolf_xxxxx",
 });
 
 (async () => {
-  const runId = await attemptDeploy(deployConfig);
+  const runId = await attemptNotifyDeploy(deployConfig);
   // Store the runId as an output of the job to be used in a CI-greenlight job.
   // This will depend on the CI platform you are using.
 })();
@@ -72,3 +72,4 @@ This package follows the [SemVer](https://semver.org/) versioning scheme. Additi
   happen too often, and we will reach out to you and give advance notice when it does.
 - Only top-level exports are considered part of the public API and covered by SemVer.
 - Addition of new fields in the API response types are not considered breaking changes.
+- Logs and debug messages are not considered part of the public API and can change at any time.

package/dist/cjs/lib/sdk/domain/attempt-deploy.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attemptDeploy = void 0;
+exports.attemptNotifyDeploy = void 0;
 const deploy_js_1 = require("../../api/deploy.js");
 const utils_js_1 = require("../../utils.js");
-async function attemptDeploy(deps, apiConfig, config) {
+async function attemptNotifyDeploy(deps, apiConfig, config) {
     const { job, log } = deps;
     const responseState = await (0, deploy_js_1.postDeploySuccess)(apiConfig, config, deps);
     if (!responseState.success) {
@@ -34,4 +34,4 @@ async function attemptDeploy(deps, apiConfig, config) {
     log.info(`✅ Run created with ID: ${responseState.runId}`);
     return responseState.runId;
 }
-exports.attemptDeploy = attemptDeploy;
+exports.attemptNotifyDeploy = attemptNotifyDeploy;

package/dist/cjs/lib/sdk/domain/poll-ci-greenlight.js

@@ -55,7 +55,7 @@ async function pollCiGreenlightStatus(deps, apiConfig, { runId, onRunStageChange
             catch (e) {
                 log.error(`Error in onRunStageChanged callback`, e);
             }
-        const urlInfo = `See ${greenlightStatus.relevantRunUrl}.`;
+        const urlInfo = `See ${greenlightStatus.relevantRunUrl}`;
         const { greenlight, relevantRunId, relevantRunUrl, relevantRunWithBugsUrl, rootRunId, rootRunUrl, runStage, } = greenlightStatus;
         if (rootRunId !== relevantRunId) {
             log.info(`Root run was superseded:

package/dist/cjs/lib/sdk/index.js

@@ -9,7 +9,7 @@ function makeQaWolfSdk({ apiKey, serviceBase = "https://app.qawolf.com/", }, { j
     const deps = { job, log, fetch };
     const apiConfig = { apiKey, serviceBase };
     return {
-        attemptDeploy: attempt_deploy_js_1.attemptDeploy.bind(null, deps, apiConfig),
+        attemptNotifyDeploy: attempt_deploy_js_1.attemptNotifyDeploy.bind(null, deps, apiConfig),
         pollCiGreenlightStatus: poll_ci_greenlight_js_1.pollCiGreenlightStatus.bind(null, deps, apiConfig),
     };
 }

package/dist/esm/lib/sdk/domain/attempt-deploy.js

@@ -1,6 +1,6 @@
 import { postDeploySuccess } from "../../api/deploy.js";
 import { assertType } from "../../utils.js";
-export async function attemptDeploy(deps, apiConfig, config) {
+export async function attemptNotifyDeploy(deps, apiConfig, config) {
     const { job, log } = deps;
     const responseState = await postDeploySuccess(apiConfig, config, deps);
     if (!responseState.success) {

package/dist/esm/lib/sdk/domain/poll-ci-greenlight.js

@@ -52,7 +52,7 @@ export async function pollCiGreenlightStatus(deps, apiConfig, { runId, onRunStag
             catch (e) {
                 log.error(`Error in onRunStageChanged callback`, e);
             }
-        const urlInfo = `See ${greenlightStatus.relevantRunUrl}.`;
+        const urlInfo = `See ${greenlightStatus.relevantRunUrl}`;
         const { greenlight, relevantRunId, relevantRunUrl, relevantRunWithBugsUrl, rootRunId, rootRunUrl, runStage, } = greenlightStatus;
         if (rootRunId !== relevantRunId) {
             log.info(`Root run was superseded:

package/dist/esm/lib/sdk/index.js

@@ -1,4 +1,4 @@
-import { attemptDeploy } from "./domain/attempt-deploy.js";
+import { attemptNotifyDeploy } from "./domain/attempt-deploy.js";
 import { defaultJobDriver } from "./job/default.js";
 import { defaultLogDriver } from "./log/default.js";
 import { pollCiGreenlightStatus } from "./domain/poll-ci-greenlight.js";
@@ -6,7 +6,7 @@ export function makeQaWolfSdk({ apiKey, serviceBase = "https://app.qawolf.com/",
     const deps = { job, log, fetch };
     const apiConfig = { apiKey, serviceBase };
     return {
-        attemptDeploy: attemptDeploy.bind(null, deps, apiConfig),
+        attemptNotifyDeploy: attemptNotifyDeploy.bind(null, deps, apiConfig),
         pollCiGreenlightStatus: pollCiGreenlightStatus.bind(null, deps, apiConfig),
     };
 }

package/dist/types/lib/sdk/domain/attempt-deploy.d.ts

@@ -1,4 +1,4 @@
 import { DeployConfig } from "../../api/deploy.js";
 import { SdkDependencies } from "../dependencies.js";
 import { ApiConfig } from "../../api-types.js";
-export declare function attemptDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<string>;
+export declare function attemptNotifyDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<string>;

package/dist/types/lib/sdk/index.d.ts

@@ -3,6 +3,6 @@ export declare function makeQaWolfSdk({ apiKey, serviceBase, }: {
     apiKey: string;
     serviceBase?: string;
 }, { job, log, fetch, }?: Partial<SdkDependencies>): {
-    attemptDeploy: (config: Partial<import("../api/deploy.js").DeployConfig>) => Promise<string>;
+    attemptNotifyDeploy: (config: Partial<import("../api/deploy.js").DeployConfig>) => Promise<string>;
     pollCiGreenlightStatus: (args_0: import("./domain/poll-ci-greenlight.js").PollCiGreenlightParams) => Promise<undefined>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/ci-sdk",
-  "version": "0.10.1",
+  "version": "0.10.3",
   "description": "A simple SDK for interacting with QAWolf in CI scripts.",
   "type": "module",
   "private": false,