@sap-ux/deploy-tooling 0.14.27 → 0.14.29

package/README.md

@@ -1,13 +1,60 @@
 #  `@sap-ux/deploy-tooling`
 
-## ui5-task
+`@sap-ux/deploy-tooling` exposes the capabilities of custom tasks to deploy and undeploy SAP Fiori projects against ABAP servers.
 
-To be documented ...
+### Pre-requisites
 
-### Configuration Examples
+- SAP component SAP_UI 7.53 or higher is installed in your SAP system
+- Service needs to be enabled and accessible from your development environment, [how to check this](https://help.sap.com/docs/SAP_NETWEAVER_AS_ABAP_752/68bf513362174d54b58cddec28794093/bb2bfe50645c741ae10000000a423f68.html?version=7.52.5)
+- For operations on a SAPUI5 ABAP repository, you need the `S_DEVELOP` authorization, [how to check this](https://sapui5.hana.ondemand.com/sdk/#/topic/91f3ecc06f4d1014b6dd926db0e91070)
+
+## CLI
+The module also exposes two commands `deploy` and `undeploy`.
+
+## Install
+
+```bash
+`npm install @sap-ux/deploy-tooling --save-dev`
+# or
+yarn add @sap-ux/deploy-tooling --dev
+```
+
+# Verify local installation
+```
+npx deploy -h
+# or
+./node_modules/.bin/deploy -h
+```
+
+## Usage
+
+```bash
+deploy [options]
+# or
+undeploy [options]
+```
+
+By default, YAML configuration is read from `ui5-deploy.yaml`, found in the root of your project when the `deploy` | `undeploy` commands are executed.
+
+To change the default configuration location, run;
+
+Deploy
+```bash
+deploy -c myproject/my-deploy-config.yaml
+# or
+deploy --config myproject/my-deploy-config.yaml
+```
+
+Undeploy
+```bash
+undeploy -c myproject/my-undeploy-config.yaml
+# or
+undeploy --config myproject/my-undeploy-config.yaml
+```
 
 #### Minimal Configuration
-This is the minimal configuration for deployment to `$TMP` without the change being recorded in a transport.
+
+This is the minimal custom task configuration for deployment using package `$TMP`, without the change being recorded in a transport request.
 
 ```yaml
 - name: abap-deploy-task
@@ -17,6 +64,8 @@ This is the minimal configuration for deployment to `$TMP` without the change be
       package: $TMP
     target:
       url: https://target.example
+    exclude:
+      - /test/
 ```
 
 #### Configuration with logging enabled
@@ -29,7 +78,7 @@ Verbose = 3,
 Debug = 4,
 Silly = 5
 ```
-Configuration example:
+Custom task YAML Configuration example:
 ```yaml
 - name: abap-deploy-task
   configuration:
@@ -39,12 +88,25 @@ Configuration example:
       package: $TMP
     target:
       url: https://target.example
+    exclude:
+      - /test/
 ```
+Or setting `verbose: true` will set the log level to `Silly`:
 
-## CLI
-The module also exposes the two commands `deploy` and `undeploy`. 
+```yaml
+- name: abap-deploy-task
+  configuration:
+    verbose: true
+    app:
+      name: Z_TEST
+      package: $TMP
+    target:
+      url: https://target.example
+    exclude:
+      - /test/
+```
 
-### deploy
+### Deploy
 The `deploy` command executes the same functionality as the `abap-deploy` UI5 task independent of the `ui5 build` execution. This allows to separate the build and the deployment process e.g. for CI/CD or to provide configurations as CLI args instead of having them defined in the `ui5.yaml` - nevertheless, the `ui5.yaml` is always required as a basis for the configuration.
 
 ```
@@ -80,7 +142,47 @@ Options:
   -h, --help                           display help for command
 ```
 
-### undeploy
+#### Deploy Examples
+
+Example 1 - Deploy to an ABAP Cloud system with strict SSL disabled
+
+```bash
+deploy --url <target-abap-system> --cloud true --name <app-name> --description '<app-description>' --package <package-name> --transport <transport-request> --no-strict-ssl
+```
+Using YAML configuration;
+```YAML
+# yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json
+
+specVersion: "3.1"
+metadata:
+  name: my.namespace.myappname
+type: application
+builder:
+  resources:
+    excludes:
+      - /test/**
+      - /localService/**
+  customTasks:
+    - name: abap-deploy-task
+      afterTask: generateCachebusterInfo
+      configuration:        
+        target:
+          url: <target-abap-system>
+          cloud: true
+        app:
+          name: <app-name>
+          description: <app-description>
+          package: <package-name>
+          transport: <transport-request>
+        exclude:
+          - /test/
+```
+Deploy CLI command;
+```bash
+deploy -c ui5-deploy.yaml --no-strict-ssl
+```
+
+### Undeploy
 The `undeploy` command allows undeploying a previously deployed application. This functionality is only available as CLI command and not as ui5 task.
 
 ```
@@ -108,4 +210,4 @@ Options:
   --test                               Run in test mode. ABAP backend reports undeployment errors without actually undeploying (use --no-test to deactivate it).
   -v, --version                        version of the deploy tooling
   -h, --help                           display help for command
-```
+```

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adeploy-tooling"
   },
-  "version": "0.14.27",
+  "version": "0.14.29",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -32,10 +32,10 @@
     "prompts": "2.4.2",
     "adm-zip": "0.5.10",
     "chalk": "4.1.2",
-    "@sap-ux/axios-extension": "1.12.4",
+    "@sap-ux/axios-extension": "1.12.6",
     "@sap-ux/btp-utils": "0.14.4",
     "@sap-ux/logger": "0.5.1",
-    "@sap-ux/system-access": "0.3.30",
+    "@sap-ux/system-access": "0.3.32",
     "@sap-ux/ui5-config": "0.22.5",
     "@sap-ux/project-input-validator": "0.2.3"
   },