Skip to content

Commit 0a06639

Browse files
committed
chore: prepare SDK project
1 parent f7b66c8 commit 0a06639

File tree

12 files changed

+22
-1131
lines changed

12 files changed

+22
-1131
lines changed

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
### Specific to this repository ###
21
# tsc outputs
32
lib/*.js
43
auth/*.js
54
**/*.d.ts
65
**/*.js.map
76

87
# service-specific tsc outputs (js files)
9-
example-service/*.js
10-
# IGNORE YOUR SERVICE FILES HERE
8+
ibm-cloud-code-engine/*.js
119

1210
# file holding service credentials
1311
test/resources/auth.js

.travis.yml

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@ language: node_js
22

33
sudo: false
44

5-
# After creating your SDK project from this template repository,
6-
# uncomment this section to enable builds on the appropriate node versions.
7-
# node_js:
8-
# - 10
9-
# - 12
5+
node_js:
6+
- 10
7+
- 12
108

119
# before_install:
1210
# - 'openssl aes-256-cbc -K $my_key -iv $my_iv -in myservice.env.enc -out myservice.env -d || true'
@@ -18,23 +16,6 @@ script:
1816
- npm run check-packages
1917
# - sh scripts/typedoc/generate_typedoc.sh currently in progress
2018

21-
# After creating your SDK project from this template repository,
22-
# remove this entire "jobs" section as this is only applicable
23-
# to the template repo's travis build.
24-
jobs:
25-
include:
26-
- stage: Run node template build
27-
node_js: 10
28-
- node_js: 12
29-
- stage: Run system test with template
30-
node_js: 10
31-
script:
32-
- git clone [email protected]:CloudEngineering/sdkgen-systest.git
33-
- cd sdkgen-systest
34-
- ./install_scripts/install_deps_ubuntu.sh
35-
- ./setup_and_generate.sh -l ibm-node -t $TRAVIS_BRANCH
36-
37-
3819
after_success:
3920
- npm run report-coverage
4021

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ please ask a question at
55

66
# Issues
77
If you encounter an issue with the SDK, you are welcome to submit
8-
a [bug report](<github-repo-url>/issues).
8+
a [bug report](https://github.com/IBM/code-engine-node-sdk/issues).
99
Before that, please search for similar issues. It's possible someone has
1010
already encountered this issue.
1111

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
[![Build Status](https://travis.ibm.com/CloudEngineering/node-sdk-template.svg?token=eW5FVD71iyte6tTby8gr&branch=master)](https://travis.ibm.com/CloudEngineering/node-sdk-template)
2-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
31
<!--
4-
[![npm-version](https://img.shields.io/npm/v/CloudEngineering/node-sdk-template.svg)](https://www.npmjs.com/package/node-sdk-template)
5-
[![codecov](https://codecov.io/gh/CloudEngineering/node-sdk-template/branch/master/graph/badge.svg)](https://codecov.io/gh/CloudEngineering/node-sdk-template)
2+
[![Build Status](https://travis-ci.com/IBM/code-engine-node-sdk.svg?token=eW5FVD71iyte6tTby8gr&branch=master)](https://travis.ibm.com/IBM/code-engine-node-sdk)
3+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
4+
[![npm-version](https://img.shields.io/npm/v/IBM/code-engine-node-sdk.svg)](https://www.npmjs.com/package/code-engine-sdk)
5+
[![codecov](https://codecov.io/gh/IBM/code-engine-node-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM/code-engine-node-sdk)
66
-->
7-
# IBM Cloud MySDK Node.js SDK
8-
Node.js client library to interact with various [MySDK APIs](https://cloud.ibm.com/apidocs?category=<service-category>).
7+
# NodeJS SDK for IBM Cloud Code Engine
8+
Node.js client library to interact with the [Code Engine API](https://cloud.ibm.com/apidocs/codeengine).
99

1010
Disclaimer: this SDK is being released initially as a **pre-release** version.
1111
Changes might occur which impact applications that use this SDK.
@@ -39,12 +39,11 @@ Changes might occur which impact applications that use this SDK.
3939
<!-- --------------------------------------------------------------- -->
4040
## Overview
4141

42-
The IBM Cloud MySDK Node.js SDK allows developers to programmatically interact with the following
43-
IBM Cloud services:
42+
The IBM Cloud Code Engine Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:
4443

4544
Service Name | Import Path
4645
--- | ---
47-
[Example Service](https://cloud.ibm.com/apidocs/example-service) | mysdk/example-service/v1
46+
[Code Engine](https://cloud.ibm.com/apidocs/codeengine) | ibm-code-engine-sdk/ibm-cloud-code-engine/v1
4847

4948
## Prerequisites
5049
* You need an [IBM Cloud][ibm-cloud-onboarding] account.
@@ -55,7 +54,7 @@ Service Name | Import Path
5554
## Installation
5655

5756
```sh
58-
npm install mysdk
57+
npm install ibm-code-engine-sdk
5958
```
6059

6160
## Using the SDK
@@ -70,7 +69,7 @@ please ask a question at
7069

7170
## Issues
7271
If you encounter an issue with the SDK, you are welcome to submit
73-
a [bug report](<github-repo-url>/issues).
72+
a [bug report](https://github.com/IBM/code-engine-node-sdk/issues).
7473
Before that, please search for similar issues. It's possible someone has
7574
already encountered this issue.
7675

0 commit comments

Comments
 (0)