mirror of
https://github.com/aevea/action-kaniko.git
synced 2025-01-30 22:09:37 +01:00
feat: Allow stripping tag prefixes
This commit is contained in:
parent
4a68ad0e14
commit
6c131bc4a8
3 changed files with 35 additions and 15 deletions
46
README.md
46
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
|
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
|
the most used values. So, technically there is a single required argument
|
||||||
|
|
||||||
| variable | description | required | default |
|
| variable | description | required | default |
|
||||||
|-----------------|----------------------------------------------------------|----------|-----------------------------|
|
|------------------|----------------------------------------------------------|----------|-----------------------------|
|
||||||
| image | Name of the image you would like to push | true | |
|
| image | Name of the image you would like to push | true | |
|
||||||
|
|
||||||
## Optional Arguments
|
## Optional Arguments
|
||||||
|
|
||||||
| variable | description | required | default |
|
| variable | description | required | default |
|
||||||
|-----------------|----------------------------------------------------------|----------|-----------------------------|
|
|------------------|----------------------------------------------------------|----------|-----------------------------|
|
||||||
| registry | Docker registry where the image will be pushed | false | docker.io |
|
| registry | Docker registry where the image will be pushed | false | docker.io |
|
||||||
| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR |
|
| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR |
|
||||||
| password | Password used for authentication to the Docker registry | false | |
|
| password | Password used for authentication to the Docker registry | false | |
|
||||||
| tag | Image tag | false | latest |
|
| tag | Image tag | false | latest |
|
||||||
| cache | Enables build cache | false | false |
|
| cache | Enables build cache | false | false |
|
||||||
| cache_ttl | How long the cache should be considered valid | false | |
|
| cache_ttl | How long the cache should be considered valid | false | |
|
||||||
| cache_registry | Docker registry meant to be used as cache | false | |
|
| cache_registry | Docker registry meant to be used as cache | false | |
|
||||||
| cache_directory | Filesystem path meant to be used as cache | false | |
|
| cache_directory | Filesystem path meant to be used as cache | false | |
|
||||||
| build_file | Dockerfile filename | false | Dockerfile |
|
| build_file | Dockerfile filename | false | Dockerfile |
|
||||||
| extra_args | Additional arguments to be passed to the kaniko executor | false | |
|
| 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**
|
**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
|
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 (-).
|
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.
|
||||||
|
|
|
@ -35,6 +35,9 @@ inputs:
|
||||||
build_file:
|
build_file:
|
||||||
description: "Dockerfile filename"
|
description: "Dockerfile filename"
|
||||||
required: false
|
required: false
|
||||||
|
strip_tag_prefix:
|
||||||
|
description: "Prefix to be stripped from the tag"
|
||||||
|
required: false
|
||||||
extra_args:
|
extra_args:
|
||||||
description: "Additional arguments to be passed to the kaniko executor"
|
description: "Additional arguments to be passed to the kaniko executor"
|
||||||
required: false
|
required: false
|
||||||
|
|
|
@ -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 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=${INPUT_TAG:-$([ "$BRANCH" == "master" ] && echo latest || echo $BRANCH)}
|
||||||
export TAG=${TAG:-"latest"}
|
export TAG=${TAG:-"latest"}
|
||||||
|
export TAG=${TAG#$INPUT_STRIP_TAG_PREFIX}
|
||||||
export USERNAME=${INPUT_USERNAME:-$GITHUB_ACTOR}
|
export USERNAME=${INPUT_USERNAME:-$GITHUB_ACTOR}
|
||||||
export PASSWORD=${INPUT_PASSWORD:-$GITHUB_TOKEN}
|
export PASSWORD=${INPUT_PASSWORD:-$GITHUB_TOKEN}
|
||||||
export IMAGE=$IMAGE:$TAG
|
export IMAGE=$IMAGE:$TAG
|
||||||
|
|
Loading…
Reference in a new issue