doc,ci(ct): enable ConfigBaker image DockerHub description maintenance

Activate ConfigBaker image workflow in GitHub Actions for automated rendering, tagging, and DockerHub updates. Reintegrated and refined previously commented-out sections to ensure compatibility with multi-arch builds and improved tagging policy. This improves maintainability, ensures regular updates, and enhances support for production use cases.

Author: poikilotherm

.github/workflows/container_maintenance.yml

@@ -195,7 +195,7 @@ jobs:
     needs:
       - base-image
       - application-image
-      # - config-image
+      - configbaker-image
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -251,26 +251,26 @@ jobs:
           readme-filepath: ./src/main/docker/README.md
 
       ### CONFIGBAKER IMAGE
-      #- name: Render README for config baker image
-      #  if: toJSON(needs.config-image.outputs.rebuilt_images) != '[]'
-      #  run: |
-      #    TAGS_JSON='${{ needs.config-image.outputs.supported_tag_matrix }}'
-      #    echo "$TAGS_JSON" | jq -r 'keys | sort | reverse | .[]' |
-      #    while IFS= read -r branch; do
-      #      echo \
-      #        "- \`$( echo "$TAGS_JSON" | jq --arg v "$branch" -r '.[$v] | join("`, `")' )\`" \
-      #        "([Dockerfile](https://github.com/IQSS/dataverse/blob/${branch}/modules/container-configbaker/src/main/docker/Dockerfile)," \
-      #        "[Patches](https://github.com/IQSS/dataverse/blob/develop/modules/container-configbaker/src/backports/${branch}))" \
-      #      | tee -a "${GITHUB_WORKSPACE}/tags-config.md"
-      #    done
-      #    sed -i -e "/<\!-- TAG BLOCK HERE -->/r ${GITHUB_WORKSPACE}/tags-config.md" "./modules/container-configbaker/README.md"
-      #    cat "./modules/container-configbaker/README.md"
-      #- name: Push description to DockerHub for config baker image
-      #  if: ${{ ! inputs.dry_run && ! inputs.damp_run && toJSON(needs.config-image.outputs.rebuilt_images) != '[]' }}
-      #  uses: peter-evans/dockerhub-description@v4
-      #  with:
-      #    username: ${{ secrets.DOCKERHUB_USERNAME }}
-      #    password: ${{ secrets.DOCKERHUB_TOKEN }}
-      #    repository: gdcc/base
-      #    short-description: "Dataverse Config Baker Container Image providing setup tooling and more"
-      #    readme-filepath: ./modules/container-configbaker/README.md
+      - name: Render README for config baker image
+        if: toJSON(needs.config-image.outputs.rebuilt_images) != '[]'
+        run: |
+          TAGS_JSON='${{ needs.config-image.outputs.supported_tag_matrix }}'
+          echo "$TAGS_JSON" | jq -r 'keys | sort | reverse | .[]' |
+          while IFS= read -r branch; do
+            echo \
+              "- \`$( echo "$TAGS_JSON" | jq --arg v "$branch" -r '.[$v] | join("`, `")' )\`" \
+              "([Dockerfile](https://github.com/IQSS/dataverse/blob/${branch}/modules/container-configbaker/Dockerfile)," \
+              "[Patches](https://github.com/IQSS/dataverse/blob/develop/modules/container-configbaker/backports/${branch}))" \
+            | tee -a "${GITHUB_WORKSPACE}/tags-config.md"
+          done
+          sed -i -e "/<\!-- TAG BLOCK HERE -->/r ${GITHUB_WORKSPACE}/tags-config.md" "./modules/container-configbaker/README.md"
+          cat "./modules/container-configbaker/README.md"
+      - name: Push description to DockerHub for config baker image
+        if: ${{ ! inputs.dry_run && ! inputs.damp_run && toJSON(needs.config-image.outputs.rebuilt_images) != '[]' }}
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: gdcc/base
+          short-description: "Dataverse Config Baker Container Image providing setup tooling and more"
+          readme-filepath: ./modules/container-configbaker/README.md

modules/container-configbaker/README.md

@@ -24,14 +24,28 @@ to ask for help and guidance.
 
 ## Supported Image Tags
 
+## Supported Image Tags
+
 This image is sourced within the main upstream code [repository of the Dataverse software](https://github.com/IQSS/dataverse).
-Development and maintenance of the [image's code](https://github.com/IQSS/dataverse/tree/develop/modules/container-configbaker)
-happens there (again, by the community). Community-supported image tags are based on the two most important branches:
+Development and maintenance of the [image's code](https://github.com/IQSS/dataverse/tree/develop/modules/container-configbaker) happens there (again, by the community).
+
+Our tagging is inspired by [Bitnami](https://docs.vmware.com/en/VMware-Tanzu-Application-Catalog/services/tutorials/GUID-understand-rolling-tags-containers-index.html).
+For more detailed information about our tagging policy, please read about our [config baker image tags](https://guides.dataverse.org/en/latest/container/configbaker-image.html#supported-image-tags) in the Dataverse Containers Guide.
+
+For ease of use, here is a list of images that are currently maintained.
+
+<!-- TAG BLOCK HERE -->
+
+All of them are rolling tags, except those ending with `-r<number>`, which are the most recent immutable tags.
+The `unstable` tags are the current development branch snapshot.
+We strongly recommend using only immutable tags for production use cases.
+
+Within the main repository, you may find the image's files at `<git root>/modules/container-configbaker`.
+This Maven module uses the [Maven Docker Plugin](https://dmp.fabric8.io) to build and ship the image.
+You may use, extend, or alter this image to your liking and/or host in some different registry if you want to.
 
-- The `unstable` tag corresponds to the `develop` branch, where pull requests are merged.
-  ([`Dockerfile`](https://github.com/IQSS/dataverse/tree/develop/modules/container-configbaker/src/main/docker/Dockerfile))
-- The `alpha` tag corresponds to the `master` branch, where releases are cut from.
-  ([`Dockerfile`](https://github.com/IQSS/dataverse/tree/master/modules/container-configbaker/src/main/docker/Dockerfile))
+**Supported architectures:** This image is created as a "multi-arch image", supporting the most common architectures
+Dataverse usually runs on: AMD64 (Windows/Linux/...) and ARM64 (Apple M1/M2).
 
 ## License