vnvsa/docker-hub-readme-updater repository overview

⁠Docker hub readme updater

Docker container allowing you to update the readme of a project.

⁠Configuration

⁠Path to the readme file

This images uses the variable $README_PATH to determine which readme to push.

If not specified, the path will be guessed from $CI_PROJECT_DIR. Value will be $CI_PROJECT_DIR/README.md

⁠Credentials

It logs into docker using the following credentials (env variables):

• $DOCKER_USER
• $DOCKER_PASSWORD

⁠Destination

The path to the Docker repo can be set using $DOCKER_DESTINATION variable.

The format is <user>/<repo>. If not specified, the destination will be guessed from $DOCKER_USER and $CI_PROJECT_NAME.

⁠Use the component

include:
  - component: $CI_SERVER_FQDN/vnv/containers/docker-hub-readme-updater/docker-hub-description-updater@<VERSION>
    inputs:
      stage: push-readme
      destination: vnvsa/example
      readme_path: $CI_PROJECT_DIR/README.md

⁠Use the container

Put the following into your .gitlab-ci.yml:

Readme:
  stage: push-readme
  image: vnvsa/docker-hub-readme-updater:latest
  needs: []
  script:
    - echo ":-)"

⁠Contributing

Pull requests, bug reports, and feature requests are welcome.

⁠Contacts

• Joël Sunier⁠ @joel.sunier
• Gaëtan Ryter⁠ @gryter
• PO : Maël Pedretti⁠ @mael.pedretti

⁠License

MIT License. See the LICENSE file.