Merge pull request #30 from betadots/also_push_to_dockerhub

Also push to dockerhub

Author: rwaffen

.github/workflows/build_container.yml

@@ -42,7 +42,18 @@ jobs:
             PUPPETDB_TERMINI_VERSION=${{ matrix.puppetdb_termini_version }}
           # we can not yet build arm containers as pdk and bolt are not available for arm
           # build_arch: linux/amd64,linux/arm64
+          docker_username: ${{ vars.DOCKERHUB_USER }}
+          docker_password: ${{ secrets.DOCKERHUB_TOKEN }}
           tags: |
             ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ matrix.puppet_release }}
             ghcr.io/${{ github.repository }}:latest-${{ matrix.puppet_release }}
             ghcr.io/${{ github.repository }}:latest
+            docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ matrix.puppet_release }}
+            docker.io/${{ github.repository }}:latest-${{ matrix.puppet_release }}
+            docker.io/${{ github.repository }}:latest
+
+      - name: Update Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ vars.DOCKERHUB_USER }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}

README.md

@@ -1,16 +1,19 @@
 # Puppet Development Container
 
-maintained by [betadots GmbH](https://www.betadots.de)
+[![Maintained by betadots GmbH](https://img.shields.io/badge/Maintained%20by-betadots%20GmbH-blue.svg)](https://www.betadots.de)
+[![QA🚦](https://github.com/betadots/pdc/actions/workflows/ci.yaml/badge.svg)](https://github.com/betadots/pdc/actions/workflows/ci.yaml)
+[![Build and publish a 🛢️ container](https://github.com/betadots/pdc/actions/workflows/build_container.yml/badge.svg)](https://github.com/betadots/pdc/actions/workflows/build_container.yml)
 
-This repository holds the code base for the Puppet Development Container (PDC).
+This repository contains the code for the betadots Puppet Development Container (PDC).
 
 ## Usage
 
 ```shell
-docker run -ti ghcr.io:betadots/pdc:latest bash
+docker run -ti --rm ghcr.io:betadots/pdc:latest bash
 ```
 
-Instead of running bash, one can mount the repo and execute a script.
+Rather than using bash directly, you have the option to mount the repository and run a script.
 
+Included fixed software versions, see: [build_versions.json](build_versions.json)
 
-included fixed software see: [build_versions.json](build_versions.json)
+For any given container tag you can lookup the specific versions here: `https://github.com/betadots/pdc/blob/$TAG/build_versions.json`

RELEASE.md

@@ -3,7 +3,7 @@
 Create a Release PR.
 The release branch has to have the version in the name, because this will be used as `future_version` of the github cnahgelog generator.
 
-```
+```shell
 git switch main
 git pull -r
 git switch -c release-v1.0.0
@@ -20,7 +20,7 @@ git push origin release-v1.0.0
 
 After the merge do:
 
-```
+```shell
 git switch main
 git pull -r
 git tag v1.0.0