Merge commit '4f47d40a33fcc372fd6e939347a400730bab0f5a' into release

Author: github-actions[bot]

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [1.0.0-canary.5] - 2022-07-12
+
+- Adds alias for profile, improves error message ([#344](https://github.com/milliHQ/terraform-aws-next-js/pull/344))
+
 ## [1.0.0-canary.4] - 2022-06-07
 
 - Correctly increase version number of new packages

README.md

@@ -1,10 +1,28 @@
+<blockquote>
+  <p align="center">
+    <strong>Note</strong>
+    <br />
+    The main branch currently contains the atomic deployments alpha preview.
+    <br />
+    For the lastest stable release, check out the <a href="https://github.com/milliHQ/terraform-aws-next-js/tree/v0.x"><code>v0.x</code> branch</a>.
+  </p>
+  <p align="center">
+    Please see our blog post <a href="https://milli.is/blog/the-road-to-atomic-deployments" target="_blank" rel="noopener">"The road to Atomic Deployments"</a><br />or watch the latest release review for more information:
+    <br />
+    <br />
+    <a aria-label="Terraform Next.js for AWS: First look at the new atomic deployments feature" href="https://www.youtube.com/watch?v=NY3zKnIcLd4" target="_blank" rel="noopener">
+      <img src="https://img.youtube.com/vi/NY3zKnIcLd4/0.jpg" height="260px">
+    </a>
+
+  </p>
+</blockquote>
+
+---
+
 # Terraform Next.js module for AWS
 
 ![CI status](https://github.com/milliHQ/terraform-aws-next-js/workflows/CI/badge.svg)
 
-> **Note:** The main branch currently contains the atomic deployments alpha preview.  
-> For the lastest stable release, please see the [`v0.x` branch](https://github.com/milliHQ/terraform-aws-next-js/tree/v0.x).
-
 A zero-config Terraform module for self-hosting Next.js sites serverless on AWS Lambda.
 
 ## Features
@@ -37,10 +55,10 @@ You should have the following tools installed:
 - [Node.js](https://nodejs.org)
 - [Bash](https://www.gnu.org/software/bash/) & [curl](https://curl.se/) (Should be available by default on many Linux based images or macOS)
 
-> Additionally we assume here that you already have a public [Route53 Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html) associated with your AWS account.
+> **Note:** Additionally we assume here that you already have a public [Route53 Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html) associated with your AWS account.
 >
-> This is currently a requirement in the preview phase of atomic deployments to enable preview deployments, where each deployment gets a unique subdomain assigned.
-> This will change once atomic deployments become generally available.
+> This is a requirement in the preview phase of atomic deployments, where each deployment gets a unique subdomain assigned.
+> It will change once atomic deployments become generally available.
 
 ### Setup the Next.js Terraform module
 
@@ -156,7 +174,7 @@ module "cloudfront_cert" {
 
 module "tf_next" {
   source  = "milliHQ/next-js/aws"
-  version = "1.0.0-canary.3"
+  version = "1.0.0-canary.4"
 
   cloudfront_aliases             = local.aliases
   cloudfront_acm_certificate_arn = module.cloudfront_cert.acm_certificate_arn

examples/atomic-deployments/README.md

@@ -2,24 +2,34 @@
 
 This example shows how to use the atomic deployments feature with the [Next.js Terraform module for AWS](https://registry.terraform.io/modules/milliHQ/next-js/aws).
 
+To learn more about this feature, please see the blog post ["The road to Atomic Deployments"](https://milli.is/blog/the-road-to-atomic-deployments) or watch the release review: [First look at the new atomic deployments feature](https://youtu.be/NY3zKnIcLd4).
+
 ## Features
 
-- Unlimited parallel deployments of Next.js with a single CloudFront distribution
-- Preview deployment subdomains, e.g. `<deployment-id>.example.com`
+- ✅ &nbsp;Unlimited parallel deployments of Next.js apps served by a single CloudFront distribution
+- ✅ &nbsp;Preview deployment subdomains, e.g. `<deployment-id>.example.com`
 
-> **Note:** You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments).
+> **Notice:** You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments).
 
-## Setup
+## How to use
 
-Download the files from the example app:
+> **Cost disclaimer**: All resources that are created in your AWS account are designed to be fully serverless.
+> This means it produces **no running costs** until it is actually used (e.g. by deploying a Next.js application or when your app starts receiving requests from the web).
+> Most of the resources created are also eligible for the [AWS always free tier](https://aws.amazon.com/free/).
+>
+> Highest cost factor in this example is the Route 53 hosted zone which can [produce costs of up to $0.50 / month](https://aws.amazon.com/route53/pricing/#Hosted_Zones_and_Records) when creating a new one.
 
-```sh
-yarn create next-app --example https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments my-app
+Run [`create-next-app`](https://www.npmjs.com/package/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [yarn](https://classic.yarnpkg.com/en/docs/cli/create/) or [pnpm](https://pnpm.io/cli/create) to bootstrap the example:
 
-cd my-app
+```sh
+npx create-next-app --example https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments atomic-deployments
+# or
+yarn create next-app --example https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments atomic-deployments
+# or
+pnpm create next-app --example https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments atomic-deployments
 ```
 
-## Setup
+### Terraform setup
 
 Use Terraform to deploy the base system to your AWS account.
 
@@ -49,8 +59,7 @@ You can change `example.com` to every domain (or subdomain) that is associated w
 Then deploy the base system.
 
 ```sh
-# Expose your AWS Access Keys to the current terminal session
-# Only needed when running Terraform commands
+# Expose your AWS Access Keys (administrator) to the current terminal session
 export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
 export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 
@@ -71,24 +80,69 @@ After the deployment was successful, you should see the following output:
 > api_endpoint_access_policy_arn = "arn:aws:iam::123456789012:policy/access-api"
 ```
 
-## Build
+> For deploying your apps in the next step you can optionally [create a new IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) and assign it the policy that you got from the `api_endpoint_access_policy_arn` output.  
+> This is a security feature that prevents a full AWS account access during deployments. It only allows access to the internal API, but not to create, destroy or modify any resources in the AWS account directly.
+
+### Build
 
-Prepare the Next.js application to be deployed with Terraform:
+First, install the [`tf-next`](https://github.com/milliHQ/terraform-aws-next-js/tree/main/packages/tf-next) CLI by running:
+
+```
+npm i -g tf-next@canary
+# or
+yarn global add tf-next@canary
+# or
+pnpm add -g tf-next@canary
+```
+
+Then prepare your Next.js application for a serverless deployment:
 
 ```sh
-npm run tf-next
+tf-next build
 ```
 
-## Deploy
+### Deploy
 
-Deploy the previously built Next.js app to the AWS infrastructure:
+Deploy the previously built Next.js app to your AWS infrastructure. For the `--endpoint` flag use the domain you got from the `api_endpoint` output in the previous [Terraform Setup](#terraform-setup) step.
 
 ```sh
 tf-next deploy --endpoint https://<api-id>.execute-api.<region>.amazonaws.com
 
-> ✅ Upload complete.
-> ✅ Deployment complete.
-> Available at: https://<deployment-id>.example.com
+> success Deployment package uploaded.
+> success Deployment ready
+> Available at: https://<deployment-id>.example.com/ (copied to clipboard)
 ```
 
-You can now access your Next.js app in the browser under the `https://<deployment-id>.example.com` domain.
+You can now access your Next.js app in the browser at the `https://<deployment-id>.example.com` domain.  
+Repeat the [build](#build) & [deploy](#deploy) step for each new app or deployment you want to push to the system.
+
+## Cleanup
+
+To delete all resources from your AWS account that were created in this examples follow this steps:
+
+1. **Cleanup all deployments with the `tf-next` CLI**  
+   First, get all active deployments through the CLI
+
+   ```
+   tf-next deployment ls
+
+   >   age ▼   deployment-id                      status
+   >   5m      59ec3b01f4325c906af8573efe0d75ba   ready
+   ```
+
+   Then remove each deployment by its id:
+
+   ```
+   tf-next deployment rm 59ec3b01f4325c906af8573efe0d75ba
+   ```
+
+   Repeat this until `tf-next deployment ls` shows no more active deployments.
+
+2. **Remove the Terraform module**  
+   To remove the deployment system (with it's global resources like CloudFront, S3 etc.) that were created with Terraform:
+
+   ```
+   terraform destroy
+   ```
+
+   > **Note:** The destroy command could fail on the first execution since [Lambda@Edge functions cannot be deleted in a synchronous way](https://github.com/hashicorp/terraform-provider-aws/issues/1721). You can workaround this by simply wait ~30 minutes and then run `terraform destroy` again.

examples/atomic-deployments/main.tf

@@ -103,7 +103,8 @@ module "cloudfront_cert" {
 ##########################
 
 module "tf_next" {
-  source = "milliHQ/next-js/aws"
+  source  = "milliHQ/next-js/aws"
+  version = "1.0.0-canary.5"
 
   cloudfront_aliases             = local.aliases
   cloudfront_acm_certificate_arn = module.cloudfront_cert.acm_certificate_arn

examples/complete/README.md

@@ -1,8 +1,11 @@
 # Terraform Next.js complete example
 
+> **Warning:** This example is not fully updated for the upcoming `v1.0.0` release.  
+> We recommend following the [Atomic Deployments Example](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments) instead until this example gets an update.
+
 This example contains a fully featured Next.js app (Static files, API-Routes, SSR) that can be deployed using the [Terraform Next.js for AWS](https://registry.terraform.io/modules/milliHQ/next-js/aws) module.
 
-You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/complete).
+> **Notice:** You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/complete).
 
 ## Setup
 

examples/complete/main.tf

@@ -21,7 +21,8 @@ provider "aws" {
 }
 
 module "tf_next" {
-  source = "milliHQ/next-js/aws"
+  source  = "milliHQ/next-js/aws"
+  version = "1.0.0-canary.5"
 
   deployment_name = "tf-next-example-complete"
 

examples/next-image/README.md

@@ -1,5 +1,8 @@
 # Terraform Next.js Image component example
 
+> **Warning:** This example is not fully updated for the upcoming `v1.0.0` release.  
+> We recommend following the [Atomic Deployments Example](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments) instead until this example gets an update.
+
 This example shows the usage of Next.js together with the `next/image` component.
 You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/next-image).
 

examples/next-image/main.tf

@@ -21,7 +21,8 @@ provider "aws" {
 }
 
 module "tf_next" {
-  source = "milliHQ/next-js/aws"
+  source  = "milliHQ/next-js/aws"
+  version = "1.0.0-canary.5"
 
   deployment_name = "tf-next-example-image"
 

examples/static/README.md

@@ -1,5 +1,8 @@
 # Terraform Next.js static example
 
+> **Warning:** This example is not fully updated for the upcoming `v1.0.0` release.  
+> We recommend following the [Atomic Deployments Example](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/atomic-deployments) instead until this example gets an update.
+
 This example shows a simple static Next.js app that is deployed to S3 without lambdas using the [Terraform Next.js for AWS](https://registry.terraform.io/modules/milliHQ/next-js/aws) module.
 
 You can find the full example code on [GitHub](https://github.com/milliHQ/terraform-aws-next-js/tree/main/examples/static).

examples/static/main.tf

@@ -21,7 +21,8 @@ provider "aws" {
 }
 
 module "tf_next" {
-  source = "milliHQ/next-js/aws"
+  source  = "milliHQ/next-js/aws"
+  version = "1.0.0-canary.5"
 
   deployment_name = "tf-next-example-static"