add dokcerhub description action

2026-07-21 10:10:52 +02:00
commit 650900c57a
3 changed files with 132 additions and 0 deletions
@@ -0,0 +1,65 @@
+name: Docker Hub Description
+
+description: |
+        A wrapper around dockerhub-description that includes dependencies needed to run it on Gitea runners.
+
+        Upstream project:
+        https://github.com/peter-evans/dockerhub-description
+
+inputs:
+
+  username:
+    description: |
+        Docker Hub username. 
+        If updating a Docker Hub repository belonging to an organization, this user must have Admin permissions for the repository.
+    required: true
+
+  password:
+    required: true
+    description: Docker Hub password or Personal Access Token with read/write/delete scope.
+
+  repository:
+    required: true
+    description: Docker Hub repository in the format <namespace>/<name>
+
+  short-description:
+    required: false
+    description: Docker Hub repository short description.
+
+  readme-filepath:
+    required: false
+    description: Path to the repository readme.
+    default: "./README.md"
+
+  enable-url-completion:
+    required: false
+    description: Enables completion of relative URLs to absolute ones.
+    default: "false"
+  image-extensions:
+    required: false
+    description: File extensions that will be treated as images.
+    default: "bmp,gif,jpg,jpeg,png,svg,webp"
+
+runs:
+  using: composite
+
+  steps:
+
+    - name: Install Node dependencies
+      shell: bash
+      env:
+        SCRIPT_NAME: install_dependencies.sh
+      run: |
+        chmod +x "${{ github.action_path }}/${SCRIPT_NAME}"
+        "${{ github.action_path }}/${SCRIPT_NAME}"
+
+    - name: Update DockerHub Description
+      uses: dockerhub-description-action/peter-evans/dockerhub-description@v5
+      with:
+        username: ${{ inputs.username }}
+        password: ${{ inputs.password }}
+        repository: ${{ inputs.repository }}
+        short-description: ${{ inputs.short-description }}
+        readme-filepath: ${{ inputs.readme-filepath }}
+        enable-url-completion: ${{ inputs.enable-url-completion }}
+        image-extensions: ${{ inputs.image-extensions }}