@dotcom-tool-kit/containerised-app-with-assets 0.1.0

package/.toolkitrc.yml

@@ -0,0 +1,42 @@
+plugins:
+  - '@dotcom-tool-kit/containerised-app'
+  - '@dotcom-tool-kit/upload-assets-to-s3'
+  - '@dotcom-tool-kit/webpack'
+
+commands:
+  'run:local':
+    - Webpack:
+        envName: development # run a webpack compile before starting the server because dotcom-server-asset-loader expects a manifest to exist
+    - Node
+    - Webpack:
+        envName: development
+        watch: true
+  'deploy:review': [] # Coming soon, see https://financialtimes.atlassian.net/browse/CPREL-1280
+  'deploy:staging':
+    - Webpack:
+        envName: production
+    - UploadAssetsToS3
+    - DockerAuthCloudsmith
+    - DockerBuild
+    - DockerPush
+    - AwsAssumeRole:
+        roleArn: !toolkit/option '@dotcom-tool-kit/containerised-app.awsRoleArnStaging'
+    - HakoDeploy:
+        environments:
+          - ft-com-test-eu
+  'deploy:production':
+    - DockerAuthCloudsmith
+    - AwsAssumeRole:
+        roleArn: !toolkit/option '@dotcom-tool-kit/containerised-app.awsRoleArnProduction'
+    # HACK: the `environments` property under `HakoDeploy` gets fully overridden by the `environments`
+    # property under the !toolkit/if-defined if multiregion is true. We'll refactor this later when
+    # we decide what new YAML tags we need
+    - HakoDeploy:
+        environments:
+          - ft-com-prod-eu
+        !toolkit/if-defined '@dotcom-tool-kit/containerised-app.multiregion':
+          environments:
+            - ft-com-prod-eu
+            - ft-com-prod-us
+
+version: 2

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@dotcom-tool-kit/containerised-app-with-assets",
+  "version": "0.1.0",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
+  "license": "ISC",
+  "description": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/financial-times/dotcom-tool-kit.git",
+    "directory": "plugins/containerised-app-with-assets"
+  },
+  "bugs": "https://github.com/financial-times/dotcom-tool-kit/issues",
+  "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/containerised-app-with-assets",
+  "files": [
+    ".toolkitrc.yml",
+    "index.js"
+  ],
+  "engines": {
+    "node": "18.x || 20.x || 22.x"
+  },
+  "peerDependencies": {
+    "dotcom-tool-kit": "4.x"
+  },
+  "dependencies": {
+    "@dotcom-tool-kit/containerised-app": "^0.1.0",
+    "@dotcom-tool-kit/upload-assets-to-s3": "^4.2.7",
+    "@dotcom-tool-kit/webpack": "^4.2.7",
+    "zod": "^3.24.1"
+  }
+}

package/readme.md

@@ -0,0 +1,49 @@
+# dotcom-tool-kit/containerised-app-with-assets
+
+A bootstrap plugin that provides the required Tool Kit plugins for a containerised application that's deployed to Amazon Elastic Container Service (ECS), additionally supporting building and uploading assets to S3.
+
+  - [`@dotcom-tool-kit/containerised-app`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/containerised-app)
+  - [`@dotcom-tool-kit/upload-assets-to-s3`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/upload-assets-to-s3)
+  - [`@dotcom-tool-kit/webpack`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/webpack)
+
+This bootstrap plugin is also preconfigured to run the `Webpack` and `Node` tasks on the command `run:local`.
+
+## Installation & Usage
+
+With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/containerised-app-with-assets
+```
+
+And add it to your repo's `.toolkitrc.yml`:
+
+```yml
+plugins:
+  - '@dotcom-tool-kit/containerised-app-with-assets'
+```
+
+This plugin is only configured with the options of the plugins it depends on. You'll need to specify plugin options for the `cloudsmith`, `containerised-app`, and `docker` plugins. The bare minimum is:
+
+```yml
+options:
+  plugins:
+    '@dotcom-tool-kit/cloudsmith':
+      serviceAccount: <SERVICE_ACCOUNT_WITH_WRITE_ACCESS>
+    '@dotcom-tool-kit/containerised-app':
+      awsRoleArnStaging: <STAGING_ROLE_ARN>
+      awsRoleArnProduction: <PRODUCTION_ROLE_ARN>
+    '@dotcom-tool-kit/docker':
+      images:
+        web:
+          name: <YOUR_APP_NAME>
+```
+
+See the relevant documentation for further options:
+
+  - [`@dotcom-tool-kit/cloudsmith` plugin options](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/cloudsmith#plugin-wide-options)
+  - [`@dotcom-tool-kit/containerised-app` plugin options](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/containerised-app#plugin-wide-options)
+  - [`@dotcom-tool-kit/docker` plugin options](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/docker#plugin-wide-options)
+
+<!-- begin autogenerated docs -->
+<!-- end autogenerated docs -->