This is an automated email from the ASF dual-hosted git repository.
more pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/knox.git
The following commit(s) were added to refs/heads/master by this push:
new 055926266 KNOX-3214 Fix README for integration tests (#1120)
055926266 is described below
commit 055926266b60436056f7b0ba44aa16512c311e1e
Author: Sandeep Moré <[email protected]>
AuthorDate: Mon Dec 8 09:56:06 2025 -0500
KNOX-3214 Fix README for integration tests (#1120)
* KNOX-3214 Fix README for integration tests
---
.github/PULL_REQUEST_TEMPLATE.md | 5 +++++
.github/workflows/tests/README.md | 11 +++++++----
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 949b3a407..ffec53663 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,6 +9,11 @@
## How was this patch tested?
(Please explain how this patch was tested. For instance: running automated
unit/integration tests, manual tests. Please write down your test steps as
detailed as possible)
+
+## Integration Tests
+(Please add or update integration tests
[`.github/workflows/tests`](.github/workflows/tests) for the feature you are
adding. If no unit test is added, please explain why. Check out
[`.github/workflows/tests/README.md`](./workflows/tests/README.md) for
instructions)
+
+## UI changes
(If this patch involves UI changes, please attach a screen-shot; otherwise,
remove this)
Please review [Knox Contributing
Process](https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process#ContributionProcess-GithubWorkflow)
before opening a pull request.
diff --git a/.github/workflows/tests/README.md
b/.github/workflows/tests/README.md
index c15672daf..97cb15a40 100644
--- a/.github/workflows/tests/README.md
+++ b/.github/workflows/tests/README.md
@@ -107,12 +107,15 @@ If you want to skip the integration tests for a specific
Pull Request (e.g., doc
## Running Tests Locally
-You can run these tests locally using Docker Compose from the
`.github/workflows/compose` directory:
+You can run these tests locally using Docker Compose from the Knox source
directory:
```bash
-cd .github/workflows/compose
-docker-compose up --build --abort-on-container-exit
+docker compose -f ./.github/workflows/compose/docker-compose.yml up
--exit-code-from tests tests
```
-This will start the Knox environment and run the tests. The `tests` container
will exit once tests are complete.
+This will build knox image and start the Knox environment and run the tests.
The `tests` container will exit once tests are complete.
+To shut down the environment
+```bash
+docker compose -f ./.github/workflows/compose/docker-compose.yml down
+```
