Skip to content

Commit

Permalink
ci: Docker Hub description update
Browse files Browse the repository at this point in the history
  • Loading branch information
@buchdag
buchdag committed Dec 19, 2023
1 parent 81798c4 commit 9804703
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/dockerhub-description.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Update Docker Hub Description

on:
push:
branches:
- main
paths:
- README.md
- .github/workflows/dockerhub-description.yml

jobs:
dockerHubDescription:
name: Update Docker Hub Description
runs-on: ubuntu-latest

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

- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN_RWD }}
repository: nginxproxy/nginx-proxy
short-description: ${{ github.event.repository.description }}
enable-url-completion: true

3 comments on commit 9804703

@SchoNie
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The readme seems to be too large for dockerhub. This workflow wrote a truncated version to Dockerhub.

@buchdag
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I suspected this would happen. The README is way, way too long and dense anyway, we should have a minimal one with only base usage info at the root and detailed documentation split under /docs kinda like what I did in acme-companion, but that's really boring work.

@buchdag
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in #2357

Please sign in to comment.