Skip to content

Commit 646763e

Browse files
committed
Add breaking changes note to README and issue template.
1 parent 4f9c13e commit 646763e

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

.github/ISSUE_TEMPLATE/bug-or-unexpected-behavior.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ assignees: ''
77

88
---
99

10+
⚠️ testcontainers-python version 4.0.0 introduces breaking changes. Please review the note in the documentation (https://testcontainers-python.readthedocs.io/) before filing a bug.
11+
1012
**Describe the bug**
1113

1214
A clear and concise description of what the bug is. What did you expect to happen? What happened instead?
@@ -24,7 +26,7 @@ raise RuntimeError("something went wrong")
2426
Provide a summary of your runtime environment. Which operating system, python version, and docker version are you using? What is the version of `testcontainers-python` you are using? You can run the following commands to get the relevant information.
2527

2628
```bash
27-
# Get the operating system information (on a unix os).
29+
# Get the operating system information (e.g., on a unix os).
2830
$ uname -a
2931
# Get the python version.
3032
$ python --version

README.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ testcontainers-python
88
.. image:: https://readthedocs.org/projects/testcontainers-python/badge/?version=latest
99
:target: http://testcontainers-python.readthedocs.io/en/latest/?badge=latest
1010

11-
testcontainers-python facilitates the use of Docker containers for functional and integration testing. The collection of packages currently supports the following features.
11+
testcontainers-python facilitates the use of Docker containers for functional and integration testing.
12+
13+
.. note::
14+
15+
testcontainers-python version 4.0.0 introduces several breaking changes. To use an older version, add :code:`testcontainers-python<4` :code:`install_requires` in your :code:`setup.py` if you are building a package or your :code:`requirements.txt` for pinned dependencies.
16+
17+
- Container arguments, such as user name, database name, and ports have been unified across containers in `testcontainers/testcontainers-python#296 <https://github.com/testcontainers/testcontainers-python/pull/296>`__. You may have to update your code if you modify the default values. The unified arguments are :code:`username`, :code:`password`, :code:`dbname`, and :code:`port`. If a container exposes more than one port, the port name is :code:`[specific_name]_port`.
18+
- Class-level configuration variables have been removed in `testcontainers/testcontainers-python#296 <https://github.com/testcontainers/testcontainers-python/pull/296>`__, and configuration variables should be specified using environment variables (as before) or specified in the constructor.
19+
20+
The collection of packages currently supports the following features.
1221

1322
.. toctree::
1423

0 commit comments

Comments
 (0)