Skip to content

Commit

Permalink
Add github action to update description in docker hub manually
Browse files Browse the repository at this point in the history
  • Loading branch information
chad-earthscope committed Nov 24, 2024
1 parent ad48a63 commit dc13ba2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/workflows/docker_update_description.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Update Docker Hub description from README-docker.md

on:
workflow_dispatch: # Trigger on manual run

jobs:
push_to_registry:
name: Push description to Docker Hub repository
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
attestations: write
id-token: write
steps:
- name: Check out the repo
uses: actions/checkout@v4

- name: Sync README-docker.md with Docker Hub description
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: earthscope/ringserver
readme-filepath: ./README-docker.md
short-description: "ringserver: A SeedLink and DataLink streaming server"
2 changes: 1 addition & 1 deletion src/loadbuffer.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**************************************************************************
* loadbuffer.c
*
* TODO: Add description
* Load ring buffer data from older ring buffer versions.
*
* This file is part of the ringserver.
*
Expand Down

0 comments on commit dc13ba2

Please sign in to comment.