Skip to content

Commit 0afec13

Browse files
chore: release v0.18.0 (#663)
## 🤖 New release * `testcontainers`: 0.17.0 -> 0.18.0 <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.18.0] - 2024-06-15 ### Details #### Bug Fixes - [❗] Make `DOCKER_CONFIG` usage consistent with Docker CLI ([#654](#654)) #### Features - [❗] Support UDP and SCTP port mappings ([#655](#655)) - Impl `From<u16>` for `ContainerPort` with TCP default ([#658](#658)) - Support HTTP wait strategy ([#659](#659)) - Allow passing `u16` to `Ports` #### Miscellaneous Tasks - Use nightly `rustfmt` ([#657](#657)) #### Refactor - [❗] Get rid of associated type `ImageArgs` and rename to `cmd` ([#649](#649)) - Avoid unnecessary owned structs and boxing ([#651](#651)) - [❗] Add `ImageExt` trait to avoid explicit conversion to `RunnableImage` ([#652](#652)) - [❗] Rename `RunnableImage` to `ContainerRequest` ([#653](#653)) - [❗] Exposed and mapped ports api ([#656](#656)) - Preliminary refactoring of `wait` strategies ([#661](#661)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). ## Migration Guide ### Overview Most of the breaking changes introduced in this version primarily impact developers who implement their own images. For general usage, the API remains mostly the same, with some improvements and enhancements for better performance and flexibility. ### 1. Renaming of `RunnableImage` - **Old**: `RunnableImage` - **New**: `ContainerRequest` - **Update**: The explicit conversion from `Image` to `ContainerRequest` (formerly `RunnableImage`) is no longer necessary. Instead, you can now directly import `testcontainers::ImageExt` and override image parameters as needed. ### 2. Changes to `Image` Methods - **Method**: `Image::tag` and `Image::name` - **Old Return Type**: `String` - **New Return Type**: `&str` - **Update**: Update any code that relies on these methods to handle the new return type `&str`. This change helps improve performance by avoiding unnecessary allocations. ### 3. Changes to `Image::exposed_ports` - **Method**: `Image::exposed_ports` - **Old Return Type**: Implementation-specific or previously different. - **New Return Type**: `&[ContainerPort]` - **Update**: The method now returns a slice of `ContainerPort`, which supports exposing ports with protocols `TCP`, `UDP`, and `SCTP`. Update your code to handle the slice accordingly. ### 4. Removal of Associated Type `Args` in `Image` - **Old**: `Image` had an associated type `Args`. - **New**: The associated type `Args` is removed. - **Update**: Command arguments are now part of `Image::cmd`, which returns `impl IntoIterator<Item = impl Into<String>>`. This change allows more flexibility in specifying command arguments. Ensure your code is updated to work with the new method signature. ### 5. Simplification of Trait Implementation in `Image` - **Old**: `Image` required `Box<dyn ..>` for certain traits. - **New**: Utilizes Return Position `impl` Trait in Trait (RPITIT). - **Update**: Instead of requiring `Box<dyn ..>`, `Image` now uses RPITIT for trait returns. This change simplifies the code and improves readability and performance. Familiarize yourself with [RPITIT](https://rustc-dev-guide.rust-lang.org/return-position-impl-trait-in-trait.html) to understand its benefits and applications in your implementation. ### 6. Changes to `RunnableImage::with_mapped_port` - **Old**: `RunnableImage::with_mapped_port` - **New**: Accessible through `ImageExt::with_mapped_port` - **Update**: This method now accepts two parameters instead of a tuple. Adjust your method calls to pass the parameters separately. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1073c7c commit 0afec13

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.18.0] - 2024-06-15
6+
### Details
7+
#### Bug Fixes
8+
- [] Make `DOCKER_CONFIG` usage consistent with Docker CLI ([#654](https://github.com/testcontainers/testcontainers-rs/pull/654))
9+
10+
#### Features
11+
- [] Support UDP and SCTP port mappings ([#655](https://github.com/testcontainers/testcontainers-rs/pull/655))
12+
- Impl `From<u16>` for `ContainerPort` with TCP default ([#658](https://github.com/testcontainers/testcontainers-rs/pull/658))
13+
- Support HTTP wait strategy ([#659](https://github.com/testcontainers/testcontainers-rs/pull/659))
14+
- Allow passing `u16` to `Ports`
15+
16+
#### Miscellaneous Tasks
17+
- Use nightly `rustfmt` ([#657](https://github.com/testcontainers/testcontainers-rs/pull/657))
18+
19+
#### Refactor
20+
- [] Get rid of associated type `ImageArgs` and rename to `cmd` ([#649](https://github.com/testcontainers/testcontainers-rs/pull/649))
21+
- Avoid unnecessary owned structs and boxing ([#651](https://github.com/testcontainers/testcontainers-rs/pull/651))
22+
- [] Add `ImageExt` trait to avoid explicit conversion to `RunnableImage` ([#652](https://github.com/testcontainers/testcontainers-rs/pull/652))
23+
- [] Rename `RunnableImage` to `ContainerRequest` ([#653](https://github.com/testcontainers/testcontainers-rs/pull/653))
24+
- [] Exposed and mapped ports api ([#656](https://github.com/testcontainers/testcontainers-rs/pull/656))
25+
- Preliminary refactoring of `wait` strategies ([#661](https://github.com/testcontainers/testcontainers-rs/pull/661))
526
## [0.17.0] - 2024-05-26
627
### Details
728
#### Bug Fixes

testcontainers/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "testcontainers"
3-
version = "0.17.0"
3+
version = "0.18.0"
44
categories = ["development-tools::testing"]
55
readme = "README.md"
66
authors.workspace = true

0 commit comments

Comments
 (0)