Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 787b0bc

Browse files
committed
add local container testing docs
1 parent 0e51916 commit 787b0bc

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Container Local Build and Test
2+
==============================
3+
4+
CI builds a runtime container for the project. The local tests
5+
checks available via ``tox -p`` do not verify this because not
6+
all developers will have docker installed locally.
7+
8+
If CI is failing to build the container, then it is best to fix and
9+
test the problem locally. This would require that you have docker
10+
or podman installed on your local workstation.
11+
12+
In the following examples the command ``docker`` is interchangeable with
13+
``podman`` depending on which container cli you have installed.
14+
15+
To build the container and call it ``test``::
16+
17+
cd <root of the project>
18+
docker build -t test .
19+
20+
To verify that the container runs::
21+
22+
docker run -it test --help
23+
24+
You can pass any other command line parameters to your application
25+
instead of --help.

docs/developer/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ side-bar.
3232
how-to/lint
3333
how-to/update-tools
3434
how-to/make-release
35+
how-to/test-container
3536

3637
+++
3738

0 commit comments

Comments
 (0)