From 6c131bc4a8b336858c544c084e7f8b9211568c3c Mon Sep 17 00:00:00 2001 From: Alex Viscreanu Date: Mon, 24 Feb 2020 22:11:13 +0100 Subject: [PATCH] feat: Allow stripping tag prefixes --- README.md | 46 +++++++++++++++++++++++++++++++--------------- action.yml | 3 +++ entrypoint.sh | 1 + 3 files changed, 35 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a3b61ad..06a9e3a 100644 --- a/README.md +++ b/README.md @@ -33,24 +33,25 @@ jobs: This action aims to be as flexible as possible, so it tries to define the defaults as for what I thought of being the most used values. So, technically there is a single required argument -| variable | description | required | default | -|-----------------|----------------------------------------------------------|----------|-----------------------------| -| image | Name of the image you would like to push | true | | +| variable | description | required | default | +|------------------|----------------------------------------------------------|----------|-----------------------------| +| image | Name of the image you would like to push | true | | ## Optional Arguments -| variable | description | required | default | -|-----------------|----------------------------------------------------------|----------|-----------------------------| -| registry | Docker registry where the image will be pushed | false | docker.io | -| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR | -| password | Password used for authentication to the Docker registry | false | | -| tag | Image tag | false | latest | -| cache | Enables build cache | false | false | -| cache_ttl | How long the cache should be considered valid | false | | -| cache_registry | Docker registry meant to be used as cache | false | | -| cache_directory | Filesystem path meant to be used as cache | false | | -| build_file | Dockerfile filename | false | Dockerfile | -| extra_args | Additional arguments to be passed to the kaniko executor | false | | +| variable | description | required | default | +|------------------|----------------------------------------------------------|----------|-----------------------------| +| registry | Docker registry where the image will be pushed | false | docker.io | +| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR | +| password | Password used for authentication to the Docker registry | false | | +| tag | Image tag | false | latest | +| cache | Enables build cache | false | false | +| cache_ttl | How long the cache should be considered valid | false | | +| cache_registry | Docker registry meant to be used as cache | false | | +| cache_directory | Filesystem path meant to be used as cache | false | | +| build_file | Dockerfile filename | false | Dockerfile | +| extra_args | Additional arguments to be passed to the kaniko executor | false | | +| strip_tag_prefix | Prefix to be stripped from the tag | false | | **Here is where it gets specific, as the optional arguments become required depending on the registry targeted** @@ -154,3 +155,18 @@ If you would like to publish the image to other registries, these actions might The `tag` argument, **unless overridden**, is automatically guessed based on the branch name. If the branch is `master` then the tag will be `latest`, otherwise it will keep the branch name, but replacing any forward slash (/) with a hyphen (-). + +If the `v` prefix that it's usually added to the GitHub releases is not desired when pushed to dockerhub, the `strip_tag_prefix` allows to +specify which part of the tag should be removed. + +Example: + +```yaml +with: + registry: docker.pkg.github.com + password: ${{ secrets.GITHUB_TOKEN }} + image: kaniko + strip_tag_prefix: pre- +``` + +for the tag `pre-0.1` will push `kaniko:0.1`, as the `pre-` part will be stripped from the tag name. diff --git a/action.yml b/action.yml index e09bb95..ae18609 100644 --- a/action.yml +++ b/action.yml @@ -35,6 +35,9 @@ inputs: build_file: description: "Dockerfile filename" required: false + strip_tag_prefix: + description: "Prefix to be stripped from the tag" + required: false extra_args: description: "Additional arguments to be passed to the kaniko executor" required: false diff --git a/entrypoint.sh b/entrypoint.sh index 971d75b..76ce8fd 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -6,6 +6,7 @@ export IMAGE=${INPUT_IMAGE} export BRANCH=$(echo ${GITHUB_REF} | sed -E "s/refs\/(heads|tags)\///g" | sed -e "s/\//-/g") export TAG=${INPUT_TAG:-$([ "$BRANCH" == "master" ] && echo latest || echo $BRANCH)} export TAG=${TAG:-"latest"} +export TAG=${TAG#$INPUT_STRIP_TAG_PREFIX} export USERNAME=${INPUT_USERNAME:-$GITHUB_ACTOR} export PASSWORD=${INPUT_PASSWORD:-$GITHUB_TOKEN} export IMAGE=$IMAGE:$TAG