Home Explore Blog Models CI



docker

content/manuals/build/ci/github-actions/update-dockerhub-desc.md
5a2af35d28cfe0b62b2cc71de00f4543bb1781b4b3c82e4c000000030000050d
---
title: Update Docker Hub description with GitHub Actions
linkTitle: Update Docker Hub description
description: How to update the repository README in Docker Hub using with GitHub Actions
keywords: ci, github actions, gha, buildkit, buildx, docker hub
---

You can update the Docker Hub repository description using a third party action
called [Docker Hub Description](https://github.com/peter-evans/dockerhub-description)
with this action:

```yaml
name: ci

on:
  push:

jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up QEMU
        uses: docker/setup-qemu-action@v3

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true
          tags: user/app:latest

      - name: Update repo description
        uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
          repository: user/app
```

Chunks
32284637 (1st chunk of `content/manuals/build/ci/github-actions/update-dockerhub-desc.md`)
Title: Updating Docker Hub Repository Description with GitHub Actions
Summary
This section describes how to update the Docker Hub repository description using the 'Docker Hub Description' GitHub Action. The provided YAML configuration demonstrates how to log in to Docker Hub, set up QEMU and Docker Buildx, build and push an image, and finally, update the repository description using the specified action with the Docker Hub username, token, and repository name.