jfxs/ci-toolkit repository overview

Usage: compare-versions.sh [-d] -f <versions-file1>,<versions-file2 [-g file3]>
Options:
  -f 2 file paths separated by comma. Returns 1 if files are different, 0 otherwise
  -d display differences between files
  -g file name. Returns 1 if file has changed on last git commit, 0 otherwise
  -v | --version print version
  -h print usage

Example:
compare-versions.sh -f VERSIONS.latest,VERSIONS.new -g Dockerfile

This script gets a list of tag image with the same digest and optionaly extracts a substring of a matching tag with a regex pattern.
The output has the following format:
sha256_digest tags_list_separated_by_comma [regex_output]

Usage: get-identical-tag.sh -r <repository> -u <username> -p <password> -t <tag-version> -a <architecture> [-i <variant>] [-x <regex>]
curl and jq are mandatory
Options:
  -r Repository. Official repository starts with library. Example: library/nginx
  -u Username of repository admin account
  -p Password of repository admin account
  -t Tag
  -a Architecture: amd64, arm, arm64, 386 ...
  -i Variant, usefull for arm architecture: v6, v7 ... (Not implemented)
  -x Regex to get a substring of a matching tag of the tags list
  -v | --version print version
  -h print usage

Example:
get-identical-tag.sh -r library/nginx -u dockerhubUser -p dockerhubPassword -t latest -a amd64 returns:
sha256:0efad4d09a419dc6d574c3c3baacb804a530acd61d5eba72cb1f14e1f5ac0c8f latest,mainline,1.19.0,1.19,1
with -x option:
get-identical-tag.sh -r library/nginx -u dockerhubUser -p dockerhubPassword -t stable-alpine -a arm64 -x \"\([0-9]*\.[0-9]*\.[0-9]*\)-alpine\" returns:
sha256:676b8117782d9e8c20af8e1b19356f64acc76c981f3a65c66e33a9874877892a stable-alpine,1.18.0-alpine,1.18-alpine 1.18.0
get-identical-tag.sh -r jfxs/ci-toolkit -u dockerhubUser -p dockerhubPassword -t latest -a amd64 -x \"\([0-9]*.[0-9]*.[0-9]\)-[0-9]*\" returns:
sha256:071939073647305a2b519cb5e83b6f90f3178d812f563f56eaed53b96147f726 latest,2.2,2,2.2.1-2 2.2.1

Usage: get-local-versions.sh -f <from-image-digest> [-a <alpine-package1>,<alpine-package2>] [-p <python-package1>,<python-package2>] [-c <command1>,<command2>]  [-s <package1=version1>,<package2=version2>] [-d <versions-directory>]
Options:
  -f From image digest
  -a List of alpine packages separated by comma
  -p List of python packages separated by comma
  -c List of commands separated by comma. Version is set by the output of --version option of the cli
  -s List of specific packages with version separated by comma
  -d Directory in which the VERSIONS file is created. /etc by default
  -v | --version print version
  -h print usage

Example:
get-local-versions.sh -f ${IMAGE_FROM_SHA} -c docker -s ci-toolkit=${RELEASE_VERSION}
get-local-versions.sh -f ${IMAGE_FROM_SHA} -a python3 -p ansible-base,ansible-lint,jmespath,netaddr

Usage: get-tag-index.sh -r <repository> -u <username> -p <password> -t <tag-version>
curl and jq are mandatory
Options:
  -r Repository
  -u Username of repository admin account
  -p Password of repository admin account
  -t Tag
  -v | --version print version
  -h print usage

Example:  2.8.0-1 and 2.8.0-2 are existing tags
get-tag-index.sh -r jfxs/ansible -u dockerhubUser -p dockerhubPassword -t 2.8.0 returns 3

Usage: image-to-badge.sh -i <image> [-d <badges_directory>]
Options:
  -i Docker image
  -d badges directory, default current directory
  -v | --version print version
  -h print usage

Example:
image-to-badge.sh -i jfxs/ci-toolkit:latest -d public

Usage: readme-to-dockerhub.sh -r <repository> -u <username> -p <password> -f <filename>
curl and jq are mandatory
Options:
  -r Repository
  -u Username of repository admin account
  -p Password of repository admin account
  -f file path of the readme file
  -v | --version print version
  -h print usage

Example:
readme-to-dockerhub.sh -r jfxs/ci-toolkit -u dockerhubUser -p dockerhubPassword -f README.md

Usage: set-dockerhub-tag-multiarch.sh -u <username> -p <password> -i <source-image-amd64> -I <source-image-arm64> -r <image-repository> -t <tag> [-l] [-M] [-m]
curl and jq are mandatory

Options:
  -u username of repository admin account
  -p password of repository admin account
  -i source image amd64
  -I source image arm64
  -r image repository
  -t tag
  -l add tag latest
  -M add major version tag: 3.2.1-4 -> tag 3
  -m add minor version tag: 3.2.1-4 -> tag 3.2
  -v | --version print version
  -h print usage

Example with images build and pushed on gitlab.com registry:
set-dockerhub-tag-multiarch.sh -u dockerhubUser -p dockerhubPassword \
-i registry.gitlab.com/fxs/docker-hello-world/master-amd64:499694f5 -I registry.gitlab.com/fxs/docker-hello-world/master-arm64:499694f5 \
-r jfxs/hello-world -t 1.19.3-2 -l -M -m

Usage: set-dockerhub-tag.sh -u <username> -p <password> [-s <server>] -i <source-image> -r <image-repository> -t <tag> [-l] [-m]

Options:
  -u username of repository admin account
  -p password of repository admin account
  -s registry server. By default: docker.io (dockerhub)
  -i source image
  -r image repository
  -t tag
  -l add tag latest
  -M add major version tag: 3.2.1-4 -> tag 3
  -m add minor version tag: 3.2.1-4 -> tag 3.2
  -v | --version print version
  -h print usage

Example with images build and pushed on gitlab.com registry:
set-dockerhub-tag.sh -u dockerhubUser -p dockerhubPassword \
-i registry.gitlab.com/fxs/docker-hello-world/master-amd64:499694f5 -r jfxs/hello-world -t 1.19.3-2 -l -M -m

Usage: versions-to-readme.sh -r <readme_file> -f <versions_file> -p <pattern>
Options:
  -r Path to readme file
  -f Path to version file
  -p Text pattern to replace by versions table in readme file
  -v | --version print version
  -h print usage

Example:
versions-to-readme.sh -r README.md -f ci_versions_file_new.txt -p "See versions on"

docker run -t jfxs/ci-toolkit:1.2.1-1 cat /etc/VERSIONS