Skip to content

Commit 6f40b1d

Browse files
committed
Update CHANGELOG.md
1 parent 28f2f4c commit 6f40b1d

File tree

3 files changed

+28
-6
lines changed

3 files changed

+28
-6
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,28 @@ Possible header types:
1111

1212
## [Unreleased]
1313

14+
## v1.1.0 (2022-03-28)
15+
16+
## Breaking Changes
17+
18+
- Switch to use [`cargo-lambda`] -- which abstracts away `cargo-zigbuild` -- for
19+
building Rust code; technically this is not a _breaking_ change, but it **will** require
20+
the package to be installed with `cargo`.
21+
22+
[`cargo-lambda`]: https://crates.io/crates/cargo-lambda
23+
24+
## Features
25+
26+
- [zig] can now be installed via the `--save-optional` flag when installing this package:
27+
```shell
28+
npm i rust.aws-cdk-lambda --save-optional
29+
```
30+
- The size of the _release_ binaries deployed to AWS Lambda should now be smaller, since `cargo-lambda` passes the [`-C strip`] argument as `symbols`.
31+
- Remove existing logic to copy over binaries to the _build_ directory, as this should now be handled by `cargo-lambda` instead.
32+
33+
[zig]: https://ziglang.org/
34+
[`-c strip`]: https://doc.rust-lang.org/stable/rustc/codegen-options/index.html#strip
35+
1436
## v1.0.0 (2022-03-21)
1537

1638
## Breaking Changes

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The `RustFunction` construct creates a Lambda function with automatic bundling a
4545
$ rustup target add aarch64-unknown-linux-gnu
4646
```
4747

48-
4) Use [`cargo`] to install _cargo-lambda_:
48+
3. Use [`cargo`] to install _cargo-lambda_:
4949

5050
```shell
5151
$ cargo install cargo-lambda
@@ -277,8 +277,8 @@ Below lists some commonly used properties you can pass in to the `RustFunction`
277277
| `setupLogging` | Determines whether we want to set up [library logging](https://rust-lang-nursery.github.io/rust-cookbook/development_tools/debugging/config_log.html) - i.e. set the `RUST_LOG` environment variable - for the lambda function.<br><br>The format defaults to `warn,module_name=debug`, which means that the default log level is `warn`, and the executable or library's log level is `debug`. |
278278
| |
279279
| `features` | A list of features to activate when compiling Rust code. These must also be added to the `Cargo.toml` file. |
280-
| `buildEnvironment` | Key-value pairs that are passed in at compile time, i.e. to `cargo build` or `cargo lambda`. This differs from `environment`, which determines the environment variables which are set on the AWS Lambda function itself. |
281-
| `extraBuildArgs` | Additional arguments that are passed in at build time to `cargo lambda`. For example, [`--all-features`]. |
280+
| `buildEnvironment` | Key-value pairs that are passed in at compile time, i.e. to `cargo build` or `cargo lambda`. This differs from `environment`, which determines the environment variables which are set on the AWS Lambda function itself. |
281+
| `extraBuildArgs` | Additional arguments that are passed in at build time to `cargo lambda`. For example, [`--all-features`]. |
282282
283283
## Settings
284284
@@ -297,5 +297,5 @@ Below are some useful _global_ defaults which can be set for all Rust Lambda Fun
297297
| `MODULE_LOG_LEVEL` | Log Level for a module (i.e. the executable). Note that this value is only used when `RustFunctionProps.setupLogging` is enabled. Defaults to `debug`. |
298298
| `WORKSPACE_DIR` | Sets the root workspace directory. By default, the workspace directory is assumed to be the directory where `cdk` was invoked.<br><br>This directory should contain at the minimum a `Cargo.toml` file which defines the workspace members. |
299299
| `FEATURES` | A list of features to activate when compiling Rust code. These must also be added to the `Cargo.toml` file. |
300-
| `BUILD_ENVIRONMENT` | Key-value pairs that are passed in at compile time, i.e. to `cargo build` or `cargo lambda`. This differs from `environment`, which determines the environment variables which are set on the AWS Lambda function itself. |
301-
| `EXTRA_BUILD_ARGS` | Additional arguments that are passed in at build time to both `cargo lambda`. For example, [`--all-features`]. |
300+
| `BUILD_ENVIRONMENT` | Key-value pairs that are passed in at compile time, i.e. to `cargo build` or `cargo lambda`. This differs from `environment`, which determines the environment variables which are set on the AWS Lambda function itself. |
301+
| `EXTRA_BUILD_ARGS` | Additional arguments that are passed in at build time to both `cargo lambda`. For example, [`--all-features`]. |

lib/build.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface BaseBuildProps {
3333

3434
/**
3535
* Key-value pairs that are passed in at compile time, i.e. to `cargo
36-
* build` or `cargo zig-build`.
36+
* build` or `cargo lambda`.
3737
*
3838
* Use environment variables to apply configuration changes, such
3939
* as test and production environment configurations, without changing your

0 commit comments

Comments
 (0)