diff --git a/README.md b/README.md index c620e2a..17a15c8 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,22 @@ A GitHub Action for deploying a [tailcall](https://tailcall.run) server on AWS L ### Inputs -| Name | Description | -|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| `provider` | The provider to use for deployment. Currently, only `aws` and `fly` are supported. | -| `tailcall-config` | The path to the `tailcall` configuration file used for deployment. This file defines the server's setup and behavior. | -| `tailcall-version` | Specifies the version of `tailcall` to use for deployment. If not provided, the Action defaults to the latest available version. | -| `aws-access-key-id` | The AWS access key ID required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | -| `aws-secret-access-key` | The AWS secret access key required for authentication. Store this securely, such as in GitHub Secrets. | -| `aws-region` | The AWS region where the Lambda function will be deployed (e.g., `us-east-1`). | -| `aws-iam-role` | The IAM role name to be created and used for the deployment. If not specified, defaults to `iam_for_tailcall`. | -| `aws-lambda-function-name` | The name assigned to the created Lambda function. Defaults to `tailcall` if not specified. | -| `terraform-api-token` | The Terraform Cloud API token required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | -| `fly-api-token` | The Fly API token required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | -| `fly-app-name` | The name of the Fly app to deploy the server to. Defaults to `tailcall` if not specified. | -| `fly-region` | The Fly region where the app will be deployed. Defaults to `ord` if not specified. | +| Name | Description | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| `provider` | The provider to use for deployment. Currently, only `aws` and `fly` are supported. | +| `tailcall-config` | The path to the `tailcall` configuration file used for deployment. This file defines the server's setup and behavior. | +| `tailcall-version` | Specifies the version of `tailcall` to use for deployment. If not provided, the Action defaults to the latest available version. | +| `aws-access-key-id` | The AWS access key ID required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | +| `aws-secret-access-key` | The AWS secret access key required for authentication. Store this securely, such as in GitHub Secrets. | +| `aws-region` | The AWS region where the Lambda function will be deployed (e.g., `us-east-1`). | +| `aws-iam-role` | The IAM role name to be created and used for the deployment. If not specified, defaults to `iam_for_tailcall`. | +| `aws-lambda-function-name` | The name assigned to the created Lambda function. Defaults to `tailcall` if not specified. | +| `terraform-api-token` | The Terraform Cloud API token required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | +| `terraform-org` | The Terraform organization to use for the deployment. | +| `terraform-workspace` | The Terraform workspace to use for the deployment. | +| `fly-api-token` | The Fly API token required for authentication. Ensure this value is stored securely, such as in GitHub Secrets. | +| `fly-app-name` | The name of the Fly app to deploy the server to. Defaults to `tailcall` if not specified. | +| `fly-region` | The Fly region where the app will be deployed. Defaults to `ord` if not specified. | ## Examples