https://github.com/theo-brown/fetch-dockerhub-metadata

Github Action to get metadata of an image from DockerHub
https://github.com/theo-brown/fetch-dockerhub-metadata

actions docker docker-image metadata

Last synced: 2 months ago
JSON representation

Github Action to get metadata of an image from DockerHub

• Host: GitHub
• URL: https://github.com/theo-brown/fetch-dockerhub-metadata
• Owner: theo-brown
• License: mit
• Created: 2021-08-14T14:00:15.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-25T21:13:22.000Z (over 3 years ago)
• Last Synced: 2026-02-11T19:07:14.386Z (4 months ago)
• Topics: actions, docker, docker-image, metadata
• Language: TypeScript
• Homepage:
• Size: 293 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          


 fetch-dockerhub-metadata





 

  GitHub Action to download Docker image metadata from a DockerHub repo

 





 

 

 

 

  

 



## About

This GitHub Action makes it easy to extract labels, versions, and other image metadata

from an image hosted on DockerHub. This can be useful if, for example, you want to check that the

image on DockerHub is running the latest version of a piece of software.

**Inputs:**

- `repository` *(required)*:

  The name of a Docker repository e.g.`theobrown/fetch-dockerhub-metadata-test` 

- `tag` *(optional, default: latest)* : 

  The tag of the Docker image to fetch from the repository

**Outputs:**

- `architecture`: Docker image architecture

- `config`: String-encoded JSON containing image config (see below)

- `labels`: String-encoded JSON containing labels attached to image

- `container`: ID of container

- `container_config`: String-encoded JSON containing container config (see below)

- `created`: Timestamp of image creation

- `docker_version`: Docker version that image is built using

- `history`: String-encoded JSON containing build history

- `os`: OS running on image

- `rootfs`: Layer list

**Config JSON format**:

- `Hostname` *(string)*

- `Domainname` *(string)*

- `User` *(string)*

- `AttachStdin` *(boolean)*

- `AttachStdout` *(boolean)*

- `AttachStderr` *(boolean)*

- `ExposedPorts` *(json)*

- `Tty` *(boolean)*

- `OpenStdin` *(boolean)*

- `StdinOnce` *(boolean)*

- `Env` *(array of strings)*

- `Cmd` *(array of strings)*

- `Image` *(string)*

- `Volumes` *(array of strings)*

- `WorkingDir` *(string)*

- `Entrypoint` *(array of strings)*

- `OnBuild` *(string)* 

- `Labels` *(json)*

## Example

This example workflow is set up in this repository. The code can be found 

at [.github/workflows/example.yml](https://github.com/theo-brown/fetch-dockerhub-metadata/blob/main/.github/workflows/example.yml).

```yaml

name: 'Example workflow'

on:

  pull_request:

  push:

    branches:

      - main

      - 'releases/*'

  workflow_dispatch:

jobs:

  fetch-metadata-example:

    runs-on: ubuntu-latest

    steps:

      - name: Fetch metadata from DockerHub

        id: fetch-metadata

        uses: theo-brown/fetch-dockerhub-metadata@v1

        with:

          repository: theobrown/fetch-dockerhub-metadata-test

          tag: latest

      - name: An example step (get the label matching id 'testlabel')

        run: |

          echo '${{ steps.fetch-metadata.outputs.labels }}' | jq .testlabel

```