https://github.com/thevickypedia/describe-docker
GitHub action to update docker description
https://github.com/thevickypedia/describe-docker
Last synced: 8 months ago
JSON representation
GitHub action to update docker description
- Host: GitHub
- URL: https://github.com/thevickypedia/describe-docker
- Owner: thevickypedia
- License: mit
- Created: 2025-01-08T02:49:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-08T23:11:31.000Z (9 months ago)
- Last Synced: 2025-02-19T12:12:26.841Z (8 months ago)
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[][marketplace]
# Describe Docker
`describe-docker` is a GitHub action designed to update docker image description.
## Install Guide
#### Add `describe-docker` action to your build workflow
- In your GitHub repository, select the Actions tab and either add or edit a workflow.
- Search for `describe-docker` from the [Marketplace][marketplace] tab on the right.
- Copy and paste the yaml into your workflow.
**[OR]**
Copy & paste the following workflow definition into your project `.github/workflows/describe-docker.yml`
```yaml
name: Docker Hub Description
on:
push:
workflow_dispatch:
jobs:
describe-docker:
runs-on: ubuntu-latest
steps:
- uses: thevickypedia/describe-docker@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
summary: "Short description to summarize the docker image"
repository: "vaultapi"
filename: "README.md"
```
- Commit your changes to trigger the workflow or run the workflow manually.
### Action inputs
- `username` - Docker hub username.
- `password` - Docker hub password.
- `registry` - Docker hub registry URL (defaults to https://hub.docker.com/v2)
- `repository` - Name of the docker image repository. _Docker hub username is prefixed automatically_.
- `summary` - Docker repository overview (100-character limit)
- `filename` - Filename to read the full description for the docker image.
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[marketplace]: https://github.com/marketplace/actions/describe-docker
[license]: https://github.com/thevickypedia/describe-docker/blob/main/LICENSE