@adobe/helix-deploy 9.3.6 → 9.3.7

package/AWS.md

@@ -78,3 +78,112 @@ The is no automatic installation of the proxy functions (yet).
 
 [invoke]: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html
 
+## Getting started with `hedy` on AWS
+
+### 1. Create a Starter Project
+Create a simple JavaScript starter project. 
+
+src/index.js:
+
+```
+const { Response } = require('@adobe/fetch');
+
+/**
+ * This is the main function
+ * @param {Request} req Universal API Request
+ * @param {HEDYContext} context Universal API Context
+ * @returns {Response} a status response
+ */
+module.exports.main = async function main(req, context) {
+  const result = '{"result": "it works!"}';
+  return new Response(result, {
+    status: 200,
+  });
+}
+```
+
+package.json:
+```
+{
+  "name": "my-project",
+  "version": "1.0",
+  "private": true,
+  "main": "src/index.js",
+  "dependencies": {
+    "@adobe/fetch": "4.1.0"
+  }
+}
+```
+
+Build the project with `npm i`
+
+
+### 2. Configure your AWS account
+
+Its useful to install the AWS Command Line Interface. See [Install or update the latest version of the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
+If you're on MacOS you can just use `brew install awscli`.
+
+* Go to the [AWS UI](https://aws.amazon.com/) and in Secrets Manager create a secret called `/helix-deploy/default/all` you can enter a dummy key and value 
+for the secret and use the default values with everything else.
+<img width="1094" alt="secret" src="docs/images/secret.png">
+ 
+* Copy your account number from the top right of the console
+<img width="237" alt="acc_id" src="docs/images/acc_id.png">
+ 
+* ... and create an associated S3 bucket named `helix-deploy-bucket-<userid>`
+<img width="823" alt="bucket" src="docs/images/bucket.png">
+
+* Create an API Gateway of type 'HTTP API' with name 'API Managed by Helix Deploy'
+<img width="1132" alt="apigateway" src="docs/images/apigateway.png">
+ 
+* Create a role for invoking the Lambda. Start by giving it the `AWSLambdaBasicExecutionRole`.
+<img width="1293" alt="role" src="docs/images/role.png">
+
+* Edit the role and add the Secrets Manager -> Read -> GetSecretValue permission.
+<img width="1184" alt="perm" src="docs/images/perm.png">
+
+
+Finally, to get access from the command line to your AWS account you need to configure the AWS environment.
+
+```
+$ aws sts get-session-token
+{
+    "Credentials": {
+        "AccessKeyId": "XXXYYY",
+        "SecretAccessKey": "abcdef",
+        "SessionToken": "... lots of chars ...",
+        "Expiration": "2023-10-03T17:28:34+00:00"
+    }
+}
+```
+Set the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables to the values from the above JSON result. Note that the session has a maximum timespan of 1 hour, so you need to refresh this regularly.
+
+
+At this point you should be ready to deploy your function.
+
+```
+$ npx hedy \
+  --build --verbose --directory ~/proj/hedy/temp \
+  --entryFile ~/proj/hedy/myproj/src/index.js --deploy \
+  --target aws --aws-region eu-west-1 \
+  --aws-role 'arn:aws:iam::148835428639:role/HedyInvocationRole' \
+  --aws-api 99q7f1czdf -l minor --name "myfunc@1"
+```
+
+if all goes well, the the output will end with something like this:
+```
+{
+  "aws": {
+    "name": "amazonwebservices;host=https://99q7f1czdf.execute-api.eu-west-1.amazonaws.com",
+    "url": "https://99q7f1czdf.execute-api.eu-west-1.amazonaws.com/default/myfunc/0.0.0"
+  }
+}
+```
+
+Now you can invoke your function as follows (note the URL is as reported by the `hedy` command with a slight change to the version number):
+```
+$ curl https://99q7f1czdf.execute-api.eu-west-1.amazonaws.com/default/myfunc/v0.0
+{"result": "it works!"}
+```
+
+

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [9.3.7](https://github.com/adobe/helix-deploy/compare/v9.3.6...v9.3.7) (2023-10-07)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([c5f6f5b](https://github.com/adobe/helix-deploy/commit/c5f6f5b33a52c12839c1ac96cff46fddf2d499d0))
+
 ## [9.3.6](https://github.com/adobe/helix-deploy/compare/v9.3.5...v9.3.6) (2023-09-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "9.3.6",
+  "version": "9.3.7",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",
@@ -38,21 +38,21 @@
   "dependencies": {
     "@adobe/fastly-native-promises": "3.0.5",
     "@adobe/fetch": "4.1.0",
-    "@aws-sdk/client-apigatewayv2": "3.421.0",
-    "@aws-sdk/client-lambda": "3.421.0",
-    "@aws-sdk/client-s3": "3.421.0",
-    "@aws-sdk/client-secrets-manager": "3.421.0",
-    "@aws-sdk/client-ssm": "3.421.0",
-    "@aws-sdk/client-sts": "3.421.0",
-    "@fastly/js-compute": "3.6.1",
+    "@aws-sdk/client-apigatewayv2": "3.427.0",
+    "@aws-sdk/client-lambda": "3.427.0",
+    "@aws-sdk/client-s3": "3.427.0",
+    "@aws-sdk/client-secrets-manager": "3.427.0",
+    "@aws-sdk/client-ssm": "3.427.0",
+    "@aws-sdk/client-sts": "3.427.0",
+    "@fastly/js-compute": "3.6.2",
     "@google-cloud/functions": "3.0.1",
     "@google-cloud/secret-manager": "5.0.1",
-    "@google-cloud/storage": "7.1.0",
-    "@rollup/plugin-alias": "5.0.0",
-    "@rollup/plugin-commonjs": "25.0.4",
-    "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.2.1",
-    "@rollup/plugin-terser": "0.4.3",
+    "@google-cloud/storage": "7.2.0",
+    "@rollup/plugin-alias": "5.0.1",
+    "@rollup/plugin-commonjs": "25.0.5",
+    "@rollup/plugin-json": "6.0.1",
+    "@rollup/plugin-node-resolve": "15.2.2",
+    "@rollup/plugin-terser": "0.4.4",
     "archiver": "6.0.1",
     "chalk-template": "1.1.0",
     "constants-browserify": "1.0.0",
@@ -75,7 +75,7 @@
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "8.0.1",
-    "eslint": "8.50.0",
+    "eslint": "8.51.0",
     "husky": "8.0.3",
     "lint-staged": "14.0.1",
     "mocha": "10.2.0",