Skip to content

Commit

Permalink
Automatically update descriptions on Docker Hub
Browse files Browse the repository at this point in the history
  • Loading branch information
tarleb committed Feb 10, 2025
1 parent 733f258 commit aedd4d5
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/dockerhub-description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Update Docker Hub Description
on:
push:
branches:
- main
# REMOVE BEFORE FLIGHT: for testing
- dockerhub-descriptions
# paths:
# - versions.md
# - README.md
# - docs/**/*

workflow_dispatch:

jobs:
updateDescriptions:
name: Update description on Docker Hub
runs-on: ubuntu-latest
strategy:
matrix:
image:
- minimal
- core
- latex
- extra
- typst

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup pandoc
uses: pandoc/actions/setup@v1

- name: Short description
id: config
run: |
printf 'short_description=%s\n' \
"$(pandoc lua docs/scripts/short-description.lua \
${{ matrix.image }})" \
>> $GITHUB_OUTPUT
- name: Generate README files
run: |
make docs-${{ matrix.image }} > /tmp/README.${{ matrix.image }}.md
- name: minimal
uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
repository: pandoc/${{ matrix.image }}
readme-filepath: /tmp/README.${{ matrix.image }}.md
short-description: ${{ steps.config.outputs.short_description }}

0 comments on commit aedd4d5

Please sign in to comment.