Merge pull request #127 from devops-infra/feature/docker-descr

Add Action for description in Docker Hub

Author: ChristophShyper

.github/workflows/CRON.yml

@@ -31,4 +31,3 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TERM: xterm-256color
         run: make push VERSION_PREFIX=test-
-

.github/workflows/PUSH-MASTER.yml

@@ -10,7 +10,7 @@ jobs:
     name: Repo labels
     runs-on: ubuntu-24.04-arm
     steps:
-      - name: Checkout repository
+      - name: Checkout
         uses: actions/checkout@v4
 
       - name: Labels' config
@@ -63,3 +63,11 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TERM: xterm-256color
         run: make push
+
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ vars.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ vars.DOCKER_ORG_NAME }}/${{ github.event.repository.name }}
+          short-description: ${{ github.event.repository.description }}

Makefile

@@ -13,11 +13,11 @@ VERSION_PREFIX ?=
 CURRENT_BRANCH := $(shell echo $(GITHUB_REF) | sed 's/refs\/heads\///')
 GITHUB_SHORT_SHA := $(shell echo $(GITHUB_SHA) | cut -c1-7)
 RELEASE_BRANCH := master
-DOCKER_USER_ID := christophshyper
+DOCKER_USERNAME := christophshyper
 DOCKER_ORG_NAME := devopsinfra
 DOCKER_IMAGE := action-commit-push
 DOCKER_NAME := $(DOCKER_ORG_NAME)/$(DOCKER_IMAGE)
-GITHUB_USER_ID := ChristophShyper
+GITHUB_USERNAME := ChristophShyper
 GITHUB_ORG_NAME := devops-infra
 GITHUB_NAME := ghcr.io/$(GITHUB_ORG_NAME)/$(DOCKER_IMAGE)
 BUILD_DATE := $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
@@ -72,9 +72,9 @@ build: ## Build Docker images
 .PHONY: login
 login: ## Log into all registries
 	@echo -e "\n$(TXT_GREEN)Logging to: $(TXT_YELLOW)Docker Hub$(TXT_RESET)"
-	@echo $(DOCKER_TOKEN) | docker login -u $(DOCKER_USER_ID) --password-stdin
+	@echo $(DOCKER_TOKEN) | docker login -u $(DOCKER_USERNAME) --password-stdin
 	@echo -e "\n$(TXT_GREEN)Logging to: $(TXT_YELLOW)GitHub Packages$(TXT_RESET)"
-	@echo $(GITHUB_TOKEN) | docker login ghcr.io -u $(GITHUB_USER_ID) --password-stdin
+	@echo $(GITHUB_TOKEN) | docker login ghcr.io -u $(GITHUB_USERNAME) --password-stdin
 
 
 .PHONY: push

README.md

@@ -4,9 +4,11 @@
 
 ### Supporting `amd64` and `aarch64/arm64` images!
 
-Available in Docker Hub: [devopsinfra/action-commit-push:latest](https://hub.docker.com/repository/docker/devopsinfra/action-commit-push)
+Useful in combination with my other action [devops-infra/action-pull-request](https://github.com/devops-infra/action-pull-request).
 
-And GitHub Packages: [ghcr.io/devops-infra/docker-terragrunt/docker-terragrunt:latest](https://github.com/orgs/devops-infra/packages/container/package/action-commit-push)
+Available in Docker Hub: [devopsinfra/action-commit-push:latest](https://hub.docker.com/repository/docker/devopsinfra/action-commit-push)
+<br>
+And GitHub Packages: [ghcr.io/devops-infra/action-commit-push/action-commit-push:latest](https://github.com/orgs/devops-infra/packages/container/package/action-commit-push)
 
 
 Features: