@commercetools-frontend/deployment-cli 0.0.0-FEC-212-react19-20250122084835

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) commercetools GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# @commercetools-frontend/deployment-cli
+
+> This is a CLI used internally for Merchant Center applications. We do not provide any guarantees or support for the functionality.
+
+This CLI provides useful commands to trigger deployments through CircleCI to different cloud environment.
+
+## Usage
+
+> Please make sure you have Node.js v14 or higher installed.
+
+The CLI relies on certain configuration which has to be specified in a `deployment` [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) file for example `deployment.config.cjs` to facilitate interaction with the CircleCI API.
+
+Each of the fields in the example are required to run commands successfully:
+
+```js
+module.exports = {
+  CircleCI: {
+    projectName: 'merchant-center-application',
+  },
+};
+```
+
+Other fields exist but they are defaulted to minimize what values have to be specified:
+
+```js
+module.exports = {
+  CircleCI: {
+    apiBaseUrl: 'https://circleci.com/api/v2',
+    deploymentWorkflowName: 'test_build_and_deploy',
+    pagination: {
+      maxPages: 42,
+      pagesForPipelineSelection: 5,
+    },
+    deployments: {
+      'my-deployment-name': {
+        jobs: {
+          approval: 'approval-job-name',
+          deployment: 'deploymnet-job-name',
+        },
+      },
+    },
+  },
+};
+```
+
+### Command: `approve`
+
+This command interacts with the CircleCI API and triggers a deployment by approving it.
+
+```bash
+pnpm deployment-cli approve --approval-job=can_d_p_a-my-deployment-name
+```
+
+If a `deployments` config property is specified you can reference by:
+
+```bash
+pnpm deployment-cli approve --deployment=my-deployment-name
+```
+
+where `products` is a name of a deployment you configured in your configuration with `approval` and `deployment` (optional) configured on the `jobs` property.

package/bin/cli.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+const { exit } = require('node:process');
+const { run } = require('@commercetools-frontend/deployment-cli/cli');
+
+run().catch((error) => {
+  console.error(error.message || error.stack || error);
+  exit(1);
+});

package/cli/dist/commercetools-frontend-deployment-cli-cli.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "../../dist/declarations/src/cli.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1mcm9udGVuZC1kZXBsb3ltZW50LWNsaS1jbGkuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9kaXN0L2RlY2xhcmF0aW9ucy9zcmMvY2xpLmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEifQ==