Skip to content

Commit

Permalink
v1 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fujiwara committed Jan 27, 2024
1 parent a5c03b3 commit b8df5a2
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/v0-v1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Differences of lambroll v0 and v1.

See also issues and pull requests labeled `v1`.

## Breaking changes

- `lambroll archive` outputs zip binaries into the `function.zip` file instead of STDOUT. [#327](https://github.com/fujiwara/lambroll/pull/327)
- If you want to output to STDOUT like v1, use `lambroll archive --dest -`.
- `lambroll diff` shows a short unified diff by default. [#328](https://github.com/fujiwara/lambroll/pull/328)
- `--no-unified` option outputs a long unified diff like v1.

## New features

- Add `status` command. [#336](https://github.com/fujiwara/lambroll/pull/336), [#344](https://github.com/fujiwara/lambroll/pull/344), [#349](https://github.com/fujiwara/lambroll/pull/349).
- `status` command shows the status of the Lambda function.
- Add Lambda Function URLs features. [#330](https://github.com/fujiwara/lambroll/pull/330)
- See [README - Lambda Function URLs support](../README.md#lambda-function-urls-support).
- `deploy --function-url` option deploys a [Lambda funtion URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) related resources.
- Even if your Lambda function already has a Function URL, without `--function-url` option, `lambroll deploy` does not touch the Function URLs resources.
- `lambroll init --function-url` creates a file to deploy the Function URL related resources.
- Add a SSM template function. [#319](https://github.com/fujiwara/lambroll/pull/319)
- `{{ ssm "/path/to/parameter" }}` is replaced with the value of the SSM parameter.
- Add the `render` subcommand. [#326](https://github.com/fujiwara/lambroll/pull/326)
- `lambroll render` renders the function.json file and outputs to STDOUT.
- Accept `LAMBROLL_*` environment variables as flag values. [#345](https://github.com/fujiwara/lambroll/pull/345)
- For example, `lambroll deploy --tfstate=s3://example/terraform.tfstate` is equivalent to `LAMBROLL_TFSTATE=s3://example/terraform.tfstate lambroll deploy`.

## Internal changes

- Switch AWS SDK Go v2 from v1. [#306](https://github.com/fujiwara/lambroll/pull/306)
- Switch CLI parser to kong from kingpin. [#315](https://github.com/fujiwara/lambroll/pull/315)
- Switch to goreleaser. [#346](https://github.com/fujiwara/lambroll/pull/346)

0 comments on commit b8df5a2

Please sign in to comment.