https://github.com/hmajid2301/dockerhub-description-updater
Docker Image used to update the description on Docker Hub repos. Mirrored from, https://gitlab.com/hmajid2301/dockerhub-descriptions-updater
https://github.com/hmajid2301/dockerhub-description-updater
cli dockerhub npm script
Last synced: 2 months ago
JSON representation
Docker Image used to update the description on Docker Hub repos. Mirrored from, https://gitlab.com/hmajid2301/dockerhub-descriptions-updater
- Host: GitHub
- URL: https://github.com/hmajid2301/dockerhub-description-updater
- Owner: hmajid2301
- License: mit
- Created: 2020-03-08T18:11:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-07T17:38:18.000Z (about 2 years ago)
- Last Synced: 2026-03-29T21:06:54.850Z (4 months ago)
- Topics: cli, dockerhub, npm, script
- Language: JavaScript
- Homepage:
- Size: 531 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Hub Description
Docker Image used to update the description on Docker Hub repos. The image comes with pandoc so you convert your
documents to markdown.
## Usage
You can the node script like so.
```
npm install dockerhub
npm i dockerhub-description-updater
touch .env
source .env
dockerhub_description_updater
```
### Args
```bash
dockerhub_description_updater --help
Usage: src [options]
Updates description of Docker Hub repository.
Options:
--version Show version number [boolean]
-u, --username Docker Hub username. [required]
-p, --password Docker Hub password (cannot be an access token). [required]
-r, --repoName The repository name that you want to update the description
off. [required]
-x, --repoPrefix The prefix of the repository you want to update, If not set
defaults to username.
-f, --readmePath Path to README file which will be used as the description of
repository on Docker Hub. [default: "./README.md"]
-h, --help Show help [boolean]
```
### Docker
You can run the Docker container locally like so.
```bash
touch .env
docker run -rm -v README.md:/app/README.md --env-file .env hmajid2301/dockerhub-descriptions-updater
```
or you can build it locally
```
npm run build
docker build -t dockerhub-descriptions-updater .
docker run -v README.md:/app/README.md --env-file .env dockerhub-descriptions-updater
```
Where `.env` is like:
```.env
DOCKERHUB_USERNAME=hmajid2301
DOCKERHUB_PASSWORD=MY_PASS
DOCKERHUB_REPO_PREFIX=hmajid2301
DOCKERHUB_REPO_NAME=dockerhub-descriptions-updater
DOCKERHUB_README_PATH=/app/README.md
```
### .gitlab-ci.yml
You can also use it during CI/CD. The image comes with `pandoc`, so you can convert documents to markdown and
then update the full description to the specified repo.
```yaml
publish-readme:hub:
stage: pre-publish
image:
name: hmajid2301/dockerhub-descriptions
entrypoint: [""]
variables:
DOCKERHUB_USERNAME: hmajid2301
DOCKERHUB_PASSWORD: ${DOCKER_PASSWORD}
DOCKERHUB_REPO_NAME: markdown-to-devto
DOCKERHUB_README_PATH: README.md
publish-readme:hub:
script:
- pandoc --from rst README.rst --to markdown_strict -o README.md
- node /app/index.js
```
## Appendix
- Inspired by [sheogorath/readme-to-dockerhub](https://hub.docker.com/r/sheogorath/readme-to-dockerhub/dockerfile)