@evidenceai/gitlab - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "@evidenceai/gitlab",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A package to manipulate Gitlab API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,2 @@
-# Empty EAI package
+# Gitlab API
 
@@ -11,2 +11,30 @@ This package enables creating new issues in the selected Gitlab instance. The following environment variables are required to be set in the environment:
 
+## Installing this package
+
+```shell
+yarn add  @evidenceai/gitlab
+```
+
+## Using this package
+
+The following will create a new issue in the project specified by `GITLAB_CR_PROJECT_ID` on `GITLAB_HOST`:
+
+```typescript
+import {
+  isGitlabIntegrationConfigured,
+  submitContactRequest
+} from "@evidenceai/gitlab";
+
+if (!(await isGitlabIntegrationConfigured())) {
+  throw new Error("Gitlab integration is not configured");
+}
+
+await submitContactRequest({
+  email: "[e-mail]",
+  message: "tagrr signup request",
+  name: "customer name",
+  questionnaireData: "this can be anything"
+});
+```
+
 ## Bumping up version
@@ -13,0 +41,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9280

increased by6.73%

Number of lines in readme file

47

increased by147.37%

Number of medium supply chain risk alerts

1

decreased by-50%

No dependency changes