chore: improve

wundergraph · Jan 20, 2024 · 85e4b62 · 85e4b62
1 parent 10ef1e8
commit 85e4b62
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/.github/workflows/aws-router-binary-release.yaml b/.github/workflows/aws-router-binary-release.yaml
@@ -48,11 +48,10 @@ jobs:
           goarch: ${{ matrix.goarch }}
           # Where to run `go build .`
           project_path: "aws-lambda-router/cmd"
-          binary_name: "aws-lambda-router"
+          # Convention from AWS Lambda
+          binary_name: "bootstrap"
           pre_command: export CGO_ENABLED=0
           build_flags: -trimpath
-          # AWS lambda only support zip files
-          compress_assets: zip
           ldflags: -extldflags -static -X module github.com/wundergraph/cosmo/aws-lambda-router/internal.Version=${{ steps.split.outputs._1 }}
           overwrite: true
           extra_files: LICENSE

diff --git a/aws-lambda-router/README.md b/aws-lambda-router/README.md
@@ -70,4 +70,16 @@ make deploy
 ```
 
 The command will package and deploy your application to AWS.
-You can find your API Gateway Endpoint URL in the output values displayed after deployment.
+You can find your API Gateway Endpoint URL in the output values displayed after deployment.
+
+# User Guide
+
+1. Download the Lambda Router binary from the official [Router Releases](https://github.com/wundergraph/cosmo/releases?q=aws-lambda-router&expanded=true) page.
+2. Create a .zip archive with the binary and the `router.json` file. You can download the latest `router.json` with [`wgc federated-graph fetch`](https://cosmo-docs.wundergraph.com/cli/federated-graph/fetch).
+```
+.
+└── myFunction.zip/
+    ├── bootstrap
+    └── config.json
+```
+3. Deploy the .zip archive to AWS Lambda. You can use AWS cli or the AWS console. Alternatively, you can use your IaC tool of choice.