STATUS : Experimental
Automatically updates birdhouse-deploy docker images as soon as new tags are pushed.
To run the image updater using Docker:
chmod +x ./Taskfile
# remove `EXIT_BEFORE_PR=1` if you want to actually create the PR
HISTORIC_TAG_DATA_PATH=/absolute-and-writable-path EXIT_BEFORE_PR=1 CONFIG_FILE=config.test.json GITHUB_TOKEN=XXXX ./Taskfile build-run
# Clean historic tag data
HISTORIC_TAG_DATA_PATH=/absolute-and-writable-path ./Taskfile clean-data
To run the integration test via Docker:
# Run integration test. Won't push the PR, since `EXIT_BEFORE_PR=1` is seeded
HISTORIC_TAG_DATA_PATH=/absolute-and-writable-path ENV_FILE=env.test CONFIG_FILE=config.test.json ./Taskfile build-test
Add the DRY_RUN=1 parameter, to only list all the images that have new tags available.
To remove content of HISTORIC_TAG_DATA_PATH:
HISTORIC_TAG_DATA_PATH=/home/vagrant/projects/_daccs-docker-volume-test ./Taskfile clean-data
- hub (via brew)
- jq
.. and for tests ..
- python3
To run the image updater using CLI:
# remove `EXIT_BEFORE_PR=1` if you want to actually create the PR
EXIT_BEFORE_PR=1 GITHUB_TOKEN=XXXX ./main.sh
To run the integration test via CLI:
cd tests/integration && ./integration_test_runner.sh
E2E integration test with DockerHub API mock available in tests/integration.
It mimicks an image tag push on DockerHub, then runs the updater script and checks that the proper commit is made.
Makes that assumption that the hub CLI tool will open the PR properly after then.
[cronjob] : Periodically trigger main.sh
main.sh : Iterates images defined in config to call fetch_tags.sh
fetch_tags.sh : Check DockerHub image tags to trigger pr_script.sh
pr_script.sh : Clone repo, trigger bump_version.sh and create PR
bump_version.sh : Bump version of specific image in repo
- Not dependent on Github API, since abstracted in
hub - Does not require a running docker instance to manage docker image updates
- Restricted to Github repositories
- Restricted to Dockerhub images