ci(docs): update our Docker Hub documentation with our README (#5779)

Previous behavior:

Our Docker Hub is missing the documentation we use in the Zebra repository

Expected behavior:

Each time we change our README.md, or on demand, update the documentation
on Docker Hub with it. Also update the short description using our repository
description.

Solution:

Implement https://github.com/peter-evans/dockerhub-description
This commit is contained in:
Gustavo Valverde 2022-12-04 16:13:26 -04:00 committed by GitHub
parent c7ff02757d
commit ce07f4d7af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions

View File

@ -0,0 +1,30 @@
name: Update Docker Hub Description
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
on:
workflow_dispatch:
push:
branches:
- main
paths:
- README.md
- .github/workflows/dockerhub-description.yml
jobs:
dockerHubDescription:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.1.0
with:
persist-credentials: false
- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v3.1.2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
repository: zfnd/zebra
short-description: ${{ github.event.repository.description }}