https://github.com/bird-house/birdhouse-deploy-image-updater

https://github.com/bird-house/birdhouse-deploy-image-updater

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.4%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: bird-house
  • Language: Shell
  • Default Branch: master
  • Size: 95.7 KB
Statistics
  • Stars: 0
  • Watchers: 7
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created almost 6 years ago · Last pushed over 5 years ago
Metadata Files
Readme

README.md

DACCS Docker image updater

STATUS : Experimental

Automatically updates birdhouse-deploy docker images as soon as new tags are pushed.

Usage

Docker

To run the image updater using Docker:

``` chmod +x ./Taskfile

remove EXIT_BEFORE_PR=1 if you want to actually create the PR

HISTORICTAGDATAPATH=/absolute-and-writable-path EXITBEFOREPR=1 CONFIGFILE=config.test.json GITHUB_TOKEN=XXXX ./Taskfile build-run

Clean historic tag data

HISTORICTAGDATA_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

HISTORICTAGDATAPATH=/absolute-and-writable-path ENVFILE=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 HISTORICTAGDATAPATH: ``` HISTORICTAGDATAPATH=/home/vagrant/projects/_daccs-docker-volume-test ./Taskfile clean-data ```

Command line

Requirements

``` - 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

EXITBEFOREPR=1 GITHUB_TOKEN=XXXX ./main.sh ```

To run the integration test via CLI:

cd tests/integration && ./integration_test_runner.sh

Tests

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.

Flow

[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

Advantages

  • Not dependent on Github API, since abstracted in hub
  • Does not require a running docker instance to manage docker image updates

Limitations

  • Restricted to Github repositories
  • Restricted to Dockerhub images

Owner

  • Name: bird-house
  • Login: bird-house
  • Kind: organization

Making Web Processing Services easy

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 196
  • Total Committers: 1
  • Avg Commits per committer: 196.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Mathieu Provencher m****r@c****a 196
Committer Domains (Top 20 + Academic)
crim.ca: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 5.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • tlvu (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

Dockerfile docker
  • python 3.7-slim build
tests/integration/requirements.txt pypi
  • flask * test