Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: Run Unit Tests
name: Unit Test & Reports

on:
pull_request:
types: [opened, synchronize, reopened]

jobs:
run-tests:
build-test:
name: Build & Test
runs-on: ubuntu-latest
steps:
- name: Checkout code
Expand All @@ -24,5 +25,18 @@ jobs:
- name: Configure Region
run: csdx config:set:region AWS-NA

- name: Run tests
run: npm run test
- name: Run tests with coverage
run: npm run test:unit:report:json

- name: Test Report
uses: dorny/test-reporter@v1
if: success() || failure()
with:
name: Mocha Unit Test
path: report.json
reporter: mocha-json

- name: Coverage Report
uses: lucassabreu/comment-coverage-clover@main
with:
file: coverage/clover.xml
2 changes: 1 addition & 1 deletion .talismanrc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
threshold: medium
fileignoreconfig:
- filename: package-lock.json
checksum: 1cfef37e0c387725843e0178fa7587e6c7c55ca61d938995244384ecc899cab7
checksum: 942456bb38f0c8bcb78e186770c3840adeae7f9a813b8ddb015740f68610d654
- filename: .github/workflows/secrets-scan.yml
checksum: d79ec3f3288964f7d117b9ad319a54c0ebc152e35f69be8fde95522034fdfb2a
version: "1.0"
42 changes: 19 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,31 @@ $ csdx plugins:install @contentstack/apps-cli
This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).

<!-- usage -->

```sh-session
$ npm install -g @contentstack/apps-cli
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/apps-cli/1.6.0 darwin-arm64 node-v22.13.1
@contentstack/apps-cli/1.6.1 darwin-arm64 node-v18.20.2
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`csdx app`](#csdx-app)
- [`csdx app:create`](#csdx-appcreate)
- [`csdx app:delete`](#csdx-appdelete)
- [`csdx app:deploy`](#csdx-appdeploy)
- [`csdx app:get`](#csdx-appget)
- [`csdx app:install`](#csdx-appinstall)
- [`csdx app:reinstall`](#csdx-appreinstall)
- [`csdx app:uninstall`](#csdx-appuninstall)
- [`csdx app:update`](#csdx-appupdate)
* [`csdx app`](#csdx-app)
* [`csdx app:create`](#csdx-appcreate)
* [`csdx app:delete`](#csdx-appdelete)
* [`csdx app:deploy`](#csdx-appdeploy)
* [`csdx app:get`](#csdx-appget)
* [`csdx app:install`](#csdx-appinstall)
* [`csdx app:reinstall`](#csdx-appreinstall)
* [`csdx app:uninstall`](#csdx-appuninstall)
* [`csdx app:update`](#csdx-appupdate)

## `csdx app`

Expand Down Expand Up @@ -74,7 +71,7 @@ EXAMPLES
$ csdx app:update
```

_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/index.ts)_
_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/index.ts)_

## `csdx app:create`

Expand Down Expand Up @@ -114,7 +111,7 @@ EXAMPLES
$ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>
```

_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/create.ts)_
_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/create.ts)_

## `csdx app:delete`

Expand All @@ -139,7 +136,7 @@ EXAMPLES
$ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
```

_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/delete.ts)_
_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/delete.ts)_

## `csdx app:deploy`

Expand Down Expand Up @@ -177,7 +174,7 @@ EXAMPLES
$ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <hosting-with-launch> --launch-project <new> --config <config-path>
```

_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/deploy.ts)_
_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/deploy.ts)_

## `csdx app:get`

Expand Down Expand Up @@ -207,7 +204,7 @@ EXAMPLES
$ csdx app:get --org <value> --app-uid <value> --app-type organization
```

_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/get.ts)_
_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/get.ts)_

## `csdx app:install`

Expand All @@ -233,7 +230,7 @@ EXAMPLES
$ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
```

_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/install.ts)_
_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/install.ts)_

## `csdx app:reinstall`

Expand All @@ -259,7 +256,7 @@ EXAMPLES
$ csdx app:reinstall --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
```

_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/reinstall.ts)_
_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/reinstall.ts)_

## `csdx app:uninstall`

Expand All @@ -286,7 +283,7 @@ EXAMPLES
$ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
```

_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/uninstall.ts)_
_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/uninstall.ts)_

## `csdx app:update`

Expand All @@ -309,6 +306,5 @@ EXAMPLES
$ csdx app:update --app-manifest ./boilerplate/manifest.json
```

_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/update.ts)_

_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/update.ts)_
<!-- commandsstop -->
Loading