#83 Add warning (#84)

.github/workflows/docker-push-containers-to-dockerhub-and-ecr.yaml

@@ -11,8 +11,8 @@ permissions:
 jobs:
   docker-push-containers-to-dockerhub-and-ecr:
     permissions:
-      id-token: write   # This is required for requesting the JWT
-      contents: read    # This is required for actions/checkout
+      id-token: write # This is required for requesting the JWT
+      contents: read # This is required for actions/checkout
     secrets:
       AWS_DOCKER_ACCOUNT_ID: ${{ secrets.AWS_DOCKER_ACCOUNT_ID }}
       DOCKERHUB_ACCESS_TOKEN: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}

CONTRIBUTING.md

@@ -16,7 +16,7 @@ There are a number of ways you can contribute:
 
 If your contribution modifies the git repository, the following agreements must be established.
 
-*Note:*  License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
+_Note:_ License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
 In simple terms, license agreements are needed before pull requests can be accepted.
 A license agreement is not needed for submitting feature request, bug reporting, or other project management.
 

Dockerfile

@@ -21,10 +21,10 @@ USER root
 
 RUN apt-get update \
  && apt-get -y install \
-      python3 \
-      python3-dev \
-      python3-pip \
-      python3-venv \
+        python3 \
+        python3-dev \
+        python3-pip \
+        python3-venv \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/*
 
@@ -54,11 +54,11 @@ ARG SENZING_ACCEPT_EULA
 ARG SENZING_APT_INSTALL_TOOLS_PACKAGE
 
 ENV SENZING_ACCEPT_EULA=${SENZING_ACCEPT_EULA} \
-  SENZING_APT_INSTALL_TOOLS_PACKAGE=${SENZING_APT_INSTALL_TOOLS_PACKAGE}
+    SENZING_APT_INSTALL_TOOLS_PACKAGE=${SENZING_APT_INSTALL_TOOLS_PACKAGE}
 
 LABEL Name="senzing/senzingapi-tools" \
-  Maintainer="[email protected]" \
-  Version="3.12.0"
+      Maintainer="[email protected]" \
+      Version="3.12.0"
 
 # Run as "root" for system installation.
 
@@ -79,7 +79,7 @@ HEALTHCHECK CMD apt list --installed | grep senzingapi-tools
 
 RUN apt-get update \
  && apt-get -y install \
-      python3-venv \
+        python3-venv \
  && rm -rf /var/lib/apt/lists/*
 
 # Copy python virtual environment from the builder image.

README.md

@@ -1,5 +1,12 @@
 # senzingapi-tools
 
+## :warning: Warning
+
+This repository is specifically for Senzing SDK V4.
+It is not designed to work with Senzing API V3.
+
+To find the Senzing API V3 version of this repository, visit [senzingsdk-tools].
+
 ## Synopsis
 
 A Docker image with Senzingapi library and Senzing tools installed.
@@ -37,3 +44,4 @@ any use of this image complies with any relevant licenses for all software conta
 [license information]: https://senzing.com/end-user-license-agreement/
 [Senzing GitHub community]: https://github.com/Senzing/
 [senzing/senzingapi-tools]: https://hub.docker.com/r/senzing/senzingapi-tools
+[senzingsdk-tools]: https://github.com/Senzing/senzingsdk-tools

docs/README.md

@@ -1,5 +1,5 @@
-# template-docker
+# senzingapi-tools
 
 Placeholder for [GitHub pages](https://pages.github.com/).
 
-See [https://senzing.github.io/template-docker](https://senzing.github.io/template-docker).
+See [https://senzing.github.io/senzingapi-tools](https://senzing.github.io/senzingapi-tools).