From 52c2652bc15682c36331692ffa45c6f562f02c92 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Mon, 8 Jan 2024 17:34:42 +0100 Subject: [PATCH 1/3] update readme - add badges - update wording - add info on how to retriew version from a tag --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 23887be..c617a70 100644 --- a/README.md +++ b/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` From 3c9c3fe7c78c7c5c80a4fe8fdfc7a65faee9ca14 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Mon, 8 Jan 2024 17:34:52 +0100 Subject: [PATCH 2/3] md linting --- RELEASE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index e2562a8..1f43edd 100644 --- a/RELEASE.md +++ b/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 From d26709f77e4ae8faea90952bcc1ddc9fc80c110c Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Mon, 8 Jan 2024 17:35:31 +0100 Subject: [PATCH 3/3] add vars to push to docker hub --- .github/workflows/build_container.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/build_container.yml b/.github/workflows/build_container.yml index 5d22ede..7ead323 100644 --- a/.github/workflows/build_container.yml +++ b/.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 }}