Docker: shortcut ocrd-all-tool.json via ocrd-tool.json

Author: Robert Sachunsky

.circleci/config.yml

@@ -0,0 +1,51 @@
+name: Docker Image CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "master", "fix-alpha-shape" ]
+
+env:
+  REPO_NAME: ${{ github.repository }}
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        # we need tags for docker version tagging
+        fetch-tags: true
+        fetch-depth: 0
+    - # Activate cache export feature to reduce build time of images
+      name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v2
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKERIO_USERNAME }}
+        password: ${{ secrets.DOCKERIO_PASSWORD }}
+    - name: define image name from repo name
+      run: echo "IMAGE_NAME=ghcr.io/${REPO_NAME,,}" >> $GITHUB_ENV
+    - name: Build the Docker image
+      # build both tags at the same time
+      run: make docker-build DOCKER_TAG="docker.io/ocrd/cis -t ${{ env.IMAGE_NAME }}"
+    - name: Test the Docker image
+      run: docker run --rm ${{ env.IMAGE_NAME }} ocrd-cis-ocropy-segment -h
+    - name: Push to Dockerhub
+      run: docker push docker.io/ocrd/cis
+    - name: Push to Github Container Registry
+      run: docker push ${{ env.IMAGE_NAME }}
+

.github/workflows/docker.yml

@@ -1,14 +1,22 @@
-FROM ocrd/core:v2.67.2 AS base
+ARG DOCKER_BASE_IMAGE
+FROM $DOCKER_BASE_IMAGE AS base
 ARG VCS_REF
 ARG BUILD_DATE
 LABEL \
-    maintainer="https://github.com/OCR-D/ocrd_cis/issues" \
+    maintainer="https://github.com/cisocrgroup/ocrd_cis/issues" \
     org.label-schema.vcs-ref=$VCS_REF \
-    org.label-schema.vcs-url="https://github.com/OCR-D/ocrd_cis" \
-    org.label-schema.build-date=$BUILD_DATE
+    org.label-schema.vcs-url="https://github.com/cisocrgroup/ocrd_cis" \
+    org.label-schema.build-date=$BUILD_DATE \
+    org.opencontainers.image.vendor="DFG-Funded Initiative for Optical Character Recognition Development" \
+    org.opencontainers.image.title="ocrd_cis" \
+    org.opencontainers.image.description="Ocropy OCR and CIS post-correction bindings" \
+    org.opencontainers.image.source="https://github.com/cisocrgroup/ocrd_cis" \
+    org.opencontainers.image.documentation="https://github.com/cisocrgroup/ocrd_cis/blob/${VCS_REF}/README.md" \
+    org.opencontainers.image.revision=$VCS_REF \
+    org.opencontainers.image.created=$BUILD_DATE \
+    org.opencontainers.image.base.name=ocrd/core
 
 ENV GITURL="https://github.com/cisocrgroup"
-ENV DOWNLOAD_URL="http://cis.lmu.de/~finkf"
 
 SHELL ["/bin/bash", "-c"]
 
@@ -51,19 +59,23 @@ RUN apt-get update \
 
 FROM base AS postcorrection
 # install ocrd_cis (python)
-VOLUME ["/data"]
+WORKDIR /build/ocrd_cis
 COPY --from=languagemodel /etc/profiler/languages /etc/profiler/languages
 COPY --from=profiler /apps/profiler /apps/
 COPY --from=profiler /usr/lib/x86_64-linux-gnu/libicuuc.so /usr/lib//x86_64-linux-gnu/
 COPY --from=profiler /usr/lib/x86_64-linux-gnu/libicudata.so /usr/lib//x86_64-linux-gnu/
 COPY --from=profiler /usr/lib//x86_64-linux-gnu/libxerces-c-3.2.so /usr/lib//x86_64-linux-gnu/
-COPY . /build/ocrd_cis
+COPY . .
+# prepackage ocrd-tool.json as ocrd-all-tool.json
+RUN ocrd ocrd-tool ocrd_cis/ocrd-tool.json dump-tools > $(dirname $(ocrd bashlib filename))/ocrd-all-tool.json
+# install everything and reduce image size
 RUN apt-get update \
 	&& apt-get -y install --no-install-recommends gcc wget default-jre-headless \
-	&& pushd /build/ocrd_cis \
 	&& make install \
 	# test always fail, resources not available for download. Resources should be made available
 	# somewhere else, e.g. github.com/OCR-D/assets
 	# && make test \
-	&& popd \
 	&& rm -rf /build/ocrd_cis
+
+WORKDIR /data
+VOLUME /data

Dockerfile

@@ -2,23 +2,28 @@ PY ?= python3
 PIP ?= pip3
 V ?= > /dev/null 2>&1
 PKG = ocrd_cis
-TAG = flobar/ocrd_cis
+DOCKER_TAG = ocrd/cis
+DOCKER_BASE_IMAGE = docker.io/ocrd/core:v3.1.0
 SHELL = bash
 
 install:
-	${PIP} install --upgrade pip .
-install-devel:
-	${PIP} install --upgrade pip -e .
+	${PIP} install .
+
+install-devel install-dev:
+	${PIP} install -e .
+
 uninstall:
 	${PIP} uninstall ${PKG}
 
 docker-build: Dockerfile
 	docker build \
+	--build-arg DOCKER_BASE_IMAGE=$(DOCKER_BASE_IMAGE) \
 	--build-arg VCS_REF=$$(git rev-parse --short HEAD) \
 	--build-arg BUILD_DATE=$$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
-	-t $(TAG):latest .
+	-t $(DOCKER_TAG):latest .
+
 docker-push: docker-build
-	docker push $(TAG):latest
+	docker push $(DOCKER_TAG):latest
 
 TEST_SCRIPTS=$(sort $(filter-out tests/run_training_test.bash, $(wildcard tests/run_*.bash)))
 INDENT != MAX=; for NAME in $(TEST_SCRIPTS:tests/%=%); do if test $${\#MAX} -lt $${\#NAME}; then MAX=$${NAME//?/_}; fi; done; echo $$MAX
@@ -43,4 +48,4 @@ test: $(TEST_SCRIPTS)
 	@cat test_parallel.log
 	@$(RM) test_serially.log test_parallel.log
 
-.PHONY: install install-devel uninstall test docker-build docker-push
+.PHONY: install install-dev install-devel uninstall test docker-build docker-push