@itentialopensource/adapter-git 0.3.2 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/AUTH.md +29 -0
  2. package/CHANGELOG.md +16 -0
  3. package/SYSTEMINFO.md +19 -0
  4. package/TAB1.md +10 -0
  5. package/TAB2.md +61 -0
  6. package/compliance-report.json +9 -0
  7. package/compliance-report.txt +5 -0
  8. package/metadata.json +32 -8
  9. package/package.json +5 -7
  10. package/refs?service=git-upload-pack +0 -0
package/AUTH.md ADDED
@@ -0,0 +1,29 @@
1
+ ## Authenticating Git Adapter
2
+
3
+ This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
4
+
5
+ ### User and Password Authentication
6
+ The Git adapter requires user and password for authentiaction.
7
+
8
+ STEPS
9
+ 1. Ensure you have access to a Git server and that it is running
10
+ 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
11
+ 3. Use the properties below for the ```properties.auth``` field
12
+ ```json
13
+ "authentication": {
14
+ "username": "username",
15
+ "password": "password"
16
+ }
17
+ ```
18
+ 4. Restart the adapter. If your properties were set correctly, the adapter should go online.
19
+
20
+ ### Troubleshooting
21
+ - Make sure you copied over the correct username and password.
22
+ - Turn on debug level logs for the adapter in IAP Admin Essentials.
23
+ - Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
24
+ - Investigate the logs - in particular:
25
+ - The FULL REQUEST log to make sure the proper headers are being sent with the request.
26
+ - The FULL BODY log to make sure the payload is accurate.
27
+ - The CALL RETURN log to see what the other system is telling us.
28
+ - Remember when you are done to turn auth_logging off as you do not want to log credentials.
29
+ - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,20 @@
1
1
 
2
+ ## 0.3.4 [07-31-2024]
3
+
4
+ * manual migration updates
5
+
6
+ See merge request itentialopensource/adapters/devops-netops/adapter-git!8
7
+
8
+ ---
9
+
10
+ ## 0.3.3 [03-26-2024]
11
+
12
+ * Changes made at 2024.03.26_14:21PM
13
+
14
+ See merge request itentialopensource/adapters/devops-netops/adapter-git!7
15
+
16
+ ---
17
+
2
18
  ## 0.3.2 [03-13-2024]
3
19
 
4
20
  * Changes made at 2024.03.11_13:20PM
package/SYSTEMINFO.md ADDED
@@ -0,0 +1,19 @@
1
+ # Adapter for Git
2
+
3
+ Vendor: Generic Git
4
+ Homepage: https://en.wikipedia.org/wiki/Git
5
+
6
+ Product: Git
7
+ Product Page: https://en.wikipedia.org/wiki/Git
8
+
9
+ ## Introduction
10
+
11
+ We classify Git into the CI/CD domain as Git handles the versioning, building, storage and deploying of the system and components.
12
+
13
+ ## Why Integrate
14
+ The Git adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Git. With this adapter you have the ability to perform operations with Git on items such as:
15
+
16
+ - Manage projects and files in a repository
17
+
18
+ ## Additional Product Documentation
19
+ The [Git Node Library Documentation](https://www.npmjs.com/package/isomorphic-git)
package/TAB1.md ADDED
@@ -0,0 +1,10 @@
1
+ # Overview
2
+
3
+ This adapter is used to integrate the Itential Automation Platform (IAP) with the Git System. The API that was used to build the adapter for Git is usually available in the report directory of this adapter. The adapter utilizes the Git API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
4
+
5
+ ## Details
6
+ The Git adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Git. With this adapter you have the ability to perform operations with Git on items such as:
7
+
8
+ - Manage projects and files in a repository
9
+
10
+ For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
package/TAB2.md ADDED
@@ -0,0 +1,61 @@
1
+ # Adapter for Git
2
+
3
+ ## Table of Contents
4
+
5
+ - [Specific Adapter Information](#specific-adapter-information)
6
+ - [Authentication](#authentication)
7
+ - [Sample Properties](#sample-properties)
8
+ - [Swagger](#swagger)
9
+ - [Generic Adapter Information](#generic-adapter-information)
10
+
11
+ ## Specific Adapter Information
12
+ ### Authentication
13
+
14
+ This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
15
+
16
+ #### User and Password Authentication
17
+ The Git adapter requires user and password for authentiaction.
18
+
19
+ STEPS
20
+ 1. Ensure you have access to a Git server and that it is running
21
+ 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
22
+ 3. Use the properties below for the ```properties.auth``` field
23
+ ```json
24
+ "authentication": {
25
+ "username": "username",
26
+ "password": "password"
27
+ }
28
+ ```
29
+ 4. Restart the adapter. If your properties were set correctly, the adapter should go online.
30
+
31
+ #### Troubleshooting
32
+ - Make sure you copied over the correct username and password.
33
+ - Turn on debug level logs for the adapter in IAP Admin Essentials.
34
+ - Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
35
+ - Investigate the logs - in particular:
36
+ - The FULL REQUEST log to make sure the proper headers are being sent with the request.
37
+ - The FULL BODY log to make sure the payload is accurate.
38
+ - The CALL RETURN log to see what the other system is telling us.
39
+ - Remember when you are done to turn auth_logging off as you do not want to log credentials.
40
+ - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
41
+ ### Sample Properties
42
+
43
+ Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
44
+
45
+ ```json
46
+ "properties": {
47
+ "host": "localhost",
48
+ "port": 443,
49
+ "base_path": "/api/",
50
+ "version": "1.0",
51
+ "authentication": {
52
+ "username": "username",
53
+ "password": "password"
54
+ }
55
+ }
56
+ ```
57
+ ### Swagger
58
+
59
+ Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.
60
+ ## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-git/-/blob/master/README.md)
61
+
package/compliance-report.json ADDED
@@ -0,0 +1,9 @@
1
+ {
2
+ "ComplianceEntries": [
3
+ {
4
+ "name": "Compliance Summary",
5
+ "numInvalidProjects": 0,
6
+ "numValidProjects": 0
7
+ }
8
+ ]
9
+ }
package/compliance-report.txt ADDED
@@ -0,0 +1,5 @@
1
+ ---------------------------------------------------------------------------------------------
2
+ **** Project Compliance Summary ****
3
+ 0 project(s) are not valid
4
+ 0 project(s) are valid
5
+ ---------------------------------------------------------------------------------------------
package/metadata.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "adapter-git",
3
3
  "webName": "Adapter for Integration to Git",
4
- "vendor": "Git",
4
+ "vendor": "Generic",
5
5
  "product": "Git",
6
6
  "osVersion": [],
7
7
  "apiVersions": [],
@@ -17,29 +17,53 @@
17
17
  "CI/CD"
18
18
  ],
19
19
  "tags": [
20
- "CI/CD & Self-Service"
20
+ "Pipeline",
21
+ "Version Control",
22
+ "Build and Deploy"
21
23
  ],
22
24
  "useCases": [
23
- "CI/CD Pipeline"
25
+ "Automate Start of CI/CD Process",
26
+ "Create, update, manage and remove Projects",
27
+ "Automated Deployment of a new System, Application or Project",
28
+ "Versioning of Infrastructure Configuration",
29
+ "Automation of Network Configuration Changes from Repository"
24
30
  ],
25
31
  "deprecated": {
26
32
  "isDeprecated": false
27
33
  },
28
34
  "brokerSince": "",
35
+ "authMethods": [
36
+ {
37
+ "type": "Basic Auth",
38
+ "subtypes": [],
39
+ "primary": true
40
+ }
41
+ ],
29
42
  "documentation": {
30
43
  "storeLink": "",
31
44
  "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-git",
32
- "repoLink": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-git",
45
+ "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-git",
33
46
  "docLink": "https://docs.itential.com/opensource/docs/git",
34
47
  "demoLinks": [],
35
- "trainingLinks": [],
48
+ "trainingLinks": [
49
+ {
50
+ "title": "Itential Academy",
51
+ "link": "https://www.itential.com/itential-academy/"
52
+ }
53
+ ],
36
54
  "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
37
55
  "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
38
56
  "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
39
57
  "webLink": "",
40
- "vendorLink": "",
41
- "productLink": "",
42
- "apiLinks": []
58
+ "vendorLink": "https://en.wikipedia.org/wiki/Git",
59
+ "productLink": "https://en.wikipedia.org/wiki/Git",
60
+ "apiLinks": [
61
+ {
62
+ "title": "Git Node Library Documentation",
63
+ "link": "https://www.npmjs.com/package/isomorphic-git",
64
+ "public": true
65
+ }
66
+ ]
43
67
  },
44
68
  "assets": [],
45
69
  "relatedItems": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-git",
3
- "version": "0.3.2",
3
+ "version": "0.3.4",
4
4
  "description": "Itential adapter to run git commands",
5
5
  "main": "adapter.js",
6
6
  "wizardVersion": "2.44.7",
@@ -14,7 +14,6 @@
14
14
  "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
15
15
  "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
16
16
  "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
17
- "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
18
17
  "test": "npm run test:unit && npm run test:integration",
19
18
  "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
20
19
  "build": "npm run deploy",
@@ -38,10 +37,10 @@
38
37
  },
39
38
  "repository": {
40
39
  "type": "git",
41
- "url": "git@gitlab.com:itentialopensource/adapters/devops-netops/adapter-git"
40
+ "url": "git@gitlab.com:itentialopensource/adapters/adapter-git"
42
41
  },
43
42
  "author": "Itential",
44
- "homepage": "https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-git#readme",
43
+ "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-git#readme",
45
44
  "dependencies": {
46
45
  "ajv": "^8.12.0",
47
46
  "avsc": "^5.4.21",
@@ -59,10 +58,9 @@
59
58
  "eslint-config-airbnb-base": "^15.0.0",
60
59
  "eslint-plugin-import": "^2.27.5",
61
60
  "eslint-plugin-json": "^3.1.0",
62
- "mocha": "^9.0.1",
63
- "nyc": "^15.1.0",
61
+ "mocha": "^10.7.0",
64
62
  "testdouble": "^3.18.0",
65
- "winston": "^3.3.3"
63
+ "winston": "^3.13.1"
66
64
  },
67
65
  "private": false
68
66
  }
package/refs?service=git-upload-pack CHANGED
Binary file