@devopness/sdk-js 2.33.0 → 2.34.0
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.
- package/README.md +36 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,25 +74,51 @@ getUserProfile();
|
|
|
74
74
|
This package includes TypeScript declarations for every method.
|
|
75
75
|
TypeScript versions `>= 3.8` are supported.
|
|
76
76
|
|
|
77
|
-
Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
|
|
77
|
+
>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
|
|
78
|
+
|
|
79
|
+
## Development & Testing
|
|
80
|
+
To build and test the SDK locally, [**fork this repository**](https://github.com/devopness/devopness/fork) and follow these steps:
|
|
81
|
+
|
|
82
|
+
### With Docker
|
|
83
|
+
#### Pre-requisites
|
|
84
|
+
- [Docker](https://www.docker.com/products/docker-desktop/)
|
|
85
|
+
- [make](https://www.gnu.org/software/make/)
|
|
86
|
+
- `make` is pre-installed in most Linux systems. In `macOS` it is included as part of the `Xcode` command line utils
|
|
87
|
+
### Setup and run in local environment
|
|
88
|
+
#### 1. Build Docker Image
|
|
89
|
+
```
|
|
90
|
+
make build-image
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
#### 2. Install Dependencies
|
|
94
|
+
```
|
|
95
|
+
make npm-ci
|
|
96
|
+
```
|
|
78
97
|
|
|
79
|
-
|
|
80
|
-
To build and test the SDK locally, follow these steps:
|
|
81
|
-
1. Clone de repository
|
|
98
|
+
#### 3. Build SDK
|
|
82
99
|
```
|
|
83
|
-
|
|
100
|
+
make build-sdk-js
|
|
84
101
|
```
|
|
85
|
-
2. Install missing dependencies
|
|
86
102
|
|
|
87
|
-
|
|
103
|
+
#### 4. Run Tests
|
|
104
|
+
```
|
|
105
|
+
make test
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Without Docker
|
|
109
|
+
|
|
110
|
+
#### 1. Install missing dependencies
|
|
111
|
+
This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions for your operating system.
|
|
88
112
|
```
|
|
89
113
|
npm install
|
|
90
114
|
```
|
|
91
|
-
|
|
115
|
+
|
|
116
|
+
#### 2. Build SDK
|
|
92
117
|
```
|
|
93
|
-
npm run build
|
|
118
|
+
npm run build
|
|
94
119
|
```
|
|
95
|
-
|
|
120
|
+
|
|
121
|
+
#### 3. Run tests
|
|
96
122
|
```
|
|
97
123
|
npm run test
|
|
98
124
|
```
|