@qawolf/ci-sdk - npm Package Compare versions

Comparing version 0.12.0 to 0.12.1

dist/cjs/index.js

@@ -18,1 +18,2 @@ "use strict";
 __exportStar(require("./lib/sdk/index.js"), exports);
+__exportStar(require("./lib/sdk/dependencies.js"), exports);

dist/esm/index.js

 export * from "./lib/sdk/index.js";
+export * from "./lib/sdk/dependencies.js";

dist/types/index.d.ts

 export * from "./lib/sdk/index.js";
+export * from "./lib/sdk/dependencies.js";
 export type { CiGreenlightStatus, CiGreenlightStatusBase, DeployConfig, DeployStatus, } from "./lib/api/index.js";

dist/types/lib/api/ci-greenlight.d.ts

@@ -67,3 +67,3 @@ import { ApiConfig } from "../api-types.js";
  * The status of a CI greenlight run. See the API documentation here for
- * more details: https://qawolf.notion.site/dc42843313c246c8bf2a3a314ceb2c61
+ * more details: https://qawolf.notion.site/1b170576efea411fa785842a71e7c99e
  */
@@ -70,0 +70,0 @@ export type CiGreenlightStatus = CiGreenlightStatusBase & ({

dist/types/lib/api/deploy.d.ts

 import { ApiConfig } from "../api-types.js";
 import { SdkDependencies } from "../sdk/dependencies.js";
+/**
+ * Refer to our official documentation for more information:
+ * https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc
+ */
 export type DeployConfig = {
@@ -9,3 +13,3 @@ branch: string | undefined;
     deploymentUrl: string | undefined;
-    hostingService: string | undefined;
+    hostingService: "GitHub" | "GitLab" | undefined;
     sha: string | undefined;
@@ -12,0 +16,0 @@ variables: Record<string, string> | undefined;

package.json

 {
   "name": "@qawolf/ci-sdk",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "A simple SDK for interacting with QAWolf in CI scripts.",
@@ -18,3 +18,4 @@ "type": "module",
     "prepare": "npm run build",
-    "publish": "./scripts/publish.sh"
+    "npm-publish": "./scripts/publish.sh",
+    "tsc:check": "tsc --noEmit"
   },
@@ -21,0 +22,0 @@ "keywords": [],

README.md

@@ -20,2 +20,4 @@ # QAWolf CI SDK
 
+> ℹ️ [See the API documentation page for this endpoint](https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc).
+
 ```ts
@@ -25,3 +27,2 @@ import { type DeployConfig, makeQaWolfSdk } from "@qawolf/ci-sdk";
 // Edit this to your needs.
-// See documentation here: https://qawolf.notion.site/cfe5a209256448a5bcd825bcf2d87e34
 const deployConfig: DeployConfig = {
@@ -56,2 +57,4 @@ branch: undefined,
 
+> ℹ️ [See the API documentation page for this endpoint](https://qawolf.notion.site/1b170576efea411fa785842a71e7c99e).
+
 ```ts
@@ -69,3 +72,3 @@ import { makeQaWolfSdk } from "@qawolf/ci-sdk";
     // Optional: Callback to be called when the run stage changes.
-    // See https://qawolf.notion.site/dc42843313c246c8bf2a3a314ceb2c61 for
+    // See https://qawolf.notion.site/1b170576efea411fa785842a71e7c99e for
     // documentation on these run stages.
@@ -93,4 +96,6 @@ onRunStageChanged: (current, previous) => {
 - We recommend depending on the `^` range operator for this package, as it will not introduce breaking changes and guarantee
-  an up-to-date API usage version.
-- We will provide a changelog for each release, which will be available in the [CHANGELOG.md](./CHANGELOG.md) file.
+an up-to-date API usage version.
+<!-- There is a limitation in NPM preventing us from using relative links and hosting other MD files when the repository hosting code is not
+  public, hence we inline the changelog in the README. See https://github.com/npm/feedback/discussions/666 -->
+- We will provide a changelog for each release, which will be available in the Changelog section below.
 - This package major version will be bumped when an API breaking change is introduced. This won't
@@ -101,1 +106,53 @@ happen too often, and we will reach out to you and give advance notice when it does.
 - Logs and debug messages are not considered part of the public API and can change at any time.
+
+# Changelog
+
+## v0.12.1
+
+- Export dependencies types from root module.
+- Refine `DeployConfig.hostingService` type to match API requirements.
+- Fix inaccessible changelog file from NPM.
+
+## v0.12.0
+
+- Define a more restrictive `LogDriver` interface for easy integration with GHA
+  `core` interface.
+
+## v0.11.0
+
+- Support `reproducedBugs` field from CI-greenlight API.
+
+> :warning: These are the last breaking changes brought to the 0.x major version.
+> These are being introduced while the SDK hasn't been advertised to the public yet.
+> Future changes will follow the SemVer versioning scheme.
+
+BREAKING CHANGES:
+
+- `pollCiGreenlightStatus` and `attemptNotifyDeploy` now return a "result" object
+  with an `outcome` field that can be either `"success"`, `"failed"` or `"aborted"`,
+  instead of exiting the process with a non-zero code. This will provide more
+  flexibility to the user to decide how to handle the outcome.
+
+## v0.10.3
+
+BREAKING CHANGES:
+
+- Renamed `attemptDeploy` to `attemptNotifyDeploy`.
+
+## 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.
+
+### Supported Endpoints
+
+- `/api/deploy_success`
+- `/api/v0/ci-greenlight/[root-run-id]`

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43282

increased by2.17%

Lines of code

958

increased by0.74%

Number of lines in readme file

153

increased by59.38%

Worsened metrics

Number of package files

37

decreased by-2.63%

No dependency changes