@commercetools-frontend/application-cli 1.8.1 → 2.1.0

package/README.md

@@ -23,35 +23,35 @@ pnpm application-cli compile-deployments \
   --build-revision=<git_sha>
 ```
 
-The environments to compile the deployments for must be specified in a `google-storage-buckets` [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) file for example `google-storage-buckets.config.cjs` with the bucket region mapping to multiple environments. For example:
+The environments to compile the deployments for must be specified in a `storage-buckets` [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) file for example `storage-buckets.config.cjs` with the bucket region mapping to multiple environments. For example:
 
 ```js
 /**
- * @type {import('@commercetools-frontend/application-cli').TGoogleStorageBucketsConfig}
+ * @type {import('@commercetools-frontend/application-cli').TStorageBucketsConfig}
  */
 module.exports = {
-  'merchant-center-north-america': ['gcp-production-us'],
-  'merchant-center-asia': ['gcp-production-au'],
+  'merchant-center-north-america': {
+    cloudEnvironment: 'ctp_production_gcp_us-central1_v1',
+    bucketEnvironment: 'ctp-gcp-production-us',
+  },
 };
 ```
 
-The above configuration would compile for two environments in `gcp-production-us` and `gcp-production-au` each for their respective region. Yielding a `/deployments` folder for the application with the following structure:
+The above configuration would compile for one environment in `gcp-production-us` with its respective region. Yielding a `/deployments` folder for the application with the following structure:
 
 ```txt
-- public
-- gcp-production-us
-   - application.html
-   - upload-index.sh
-- gcp-production-au
-   - application.html
-   - upload-index.sh
-- upload-assets-merchant-center-north-america.sh
-- upload-assets-merchant-center-asia.sh
+- gs
+  - gcp-production-us
+     - application.html
+     - upload-index.sh
+  - upload-assets-merchant-center-north-america.sh
+  - upload-assets-merchant-center-asia.sh
 ```
 
-1. The `upload-index.sh` and `upload-assets-<bucket>.sh` scripts are generated pre-configured bash scripts for uploading the `application.html` and static assets to the respective storage bucket using `gcloud storage`.
-2. The `public` folder contains shared static assets for all environments.
-3. The `application.html` references the static assets from its respective environment's bucket
+1. The `gs` folder signals that these files will be uploaded to Google Storage which is the default storage provider
+2. The `upload-index.sh` and `upload-assets-<bucket>.sh` scripts are generated pre-configured bash scripts for uploading the `application.html` and static assets to the respective storage bucket using `gcloud storage`.
+3. The `public` folder contains shared static assets for all environments.
+4. The `application.html` references the static assets from its respective environment's bucket
 
 Depending on the environment you are deploying to, you need to:
 
@@ -60,25 +60,30 @@ Depending on the environment you are deploying to, you need to:
 
 Additionally, when specifying the `--dotenv-folder` option, you can specify a dotenv file for each environment (for example `.env.gcp-production-eu`) and a single `.env.production` dotenv file. These files are then loaded when compiling the application for the respective environment.
 
-The configuration also supports an expanded version in which each cloud environment can be linked to another bucket environment:
+The configuration also using a `defineBucketConfig` helper function to opt into defaults for bucket region and their environments:
 
 ```js
-/**
- * @type {import('@commercetools-frontend/application-cli').TGoogleStorageBucketsConfig}
- */
-module.exports = {
-  'merchant-center-europe': [
-    {
-      cloudEnvironment: 'ctp_production_aws_eu-central-1_v1',
-      bucketEnvironment: 'ctp-aws-production-fra',
-    },
-  ],
-};
+const {
+  defineStorageBucketsConfig,
+} = require('@commercetools-frontend/application-cli');
+
+module.exports = defineStorageBucketsConfig();
 ```
 
-Given the configuration above the cloud environment `ctp_production_aws_eu-central-1_v1` will be uploaded to the `merchant-center-europe` bucket region within the `ctp-aws-production-fra` folder as the bucket environment.
+Given the configuration above upload scripts and `application.html` files would be generated for all default bucket regions and cloud environments. These can then be picked up by the CircleCI Orb for upload.
 
-This is useful as cloud and bucket environments do not fall in the same lifecycle. A Kubernetes cluster is versioned and may have to change (e.g. be updated) without that needing to be reflected in the respective bucket environment. Also two cloud environments (e.g. in different versions) can be served from one bucket environment if needed.
+If you need to disable certain bucket regions or cloud environments, you can use the `options` parameter of `defineBucketConfig`:
+
+You can disable existing bucket regions or environments:
+
+```js
+module.exports =  defineStorageBucketsConfig({
+  options: {
+    disabledBucketRegions: ['merchant-center-north-america']
+    disabledEnvironments: ['vw_production_aws_eu-central-1_v1']
+  },
+});
+```
 
 ### Command: `compile-menu`
 

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

@@ -1,2 +1,2 @@
 export * from "../../dist/declarations/src/cli";
-//# sourceMappingURL=commercetools-frontend-application-cli-cli.cjs.d.ts.map
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1mcm9udGVuZC1hcHBsaWNhdGlvbi1jbGktY2xpLmNqcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vZGlzdC9kZWNsYXJhdGlvbnMvc3JjL2NsaS5kLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBIn0=