pokeapi-api-data/updater/README.md
Alessandro Pezzè a097eab252
Update README.md
2020-07-29 13:16:26 +02:00

1.4 KiB

Updater Bot

Docker Repository on Quay

Usage

First, make sure you can read/write the target repository over SSH. Launch the bot with a volume containing the SSH keys to /root/.ssh and an environment variable for email address. Since this container runs Docker within itself, it needs to run in privileged mode.

docker run --privileged -v ~/.ssh:/root/.ssh -e COMMIT_EMAIL=example@example.com quay.io/pokeapi/updater

Check the log for failed clones, sometimes Magikarp times out.

Environment Variables

Required

  • COMMIT_EMAIL

Optional

See the Dockerfile for the defaults.

  • COMMIT_NAME
  • COMMIT_MESSAGE
  • BRANCH_NAME
  • REPO_POKEAPI
  • REPO_DATA

Build Docker image

docker build -t pokeapi-updater .

Run on Windows

Your public/private keys with KeyName name will be shared with the pokeapi-updater container. Be sure those keys are the ones with write access on https://github.com/PokeAPI/pokeapi

pwsh Run-Updater.ps1 -KeyName id_rsa -CommitterEmail example@example.com