5 Commits
v0.2 ... v0.3.2

Author SHA1 Message Date
Simon Prochazka
73a7639472 chore: Rename organization to aevea 2020-04-26 18:43:20 +02:00
Remon Oldenbeuving
3e63daf6fe fix: Ensure lowercase GitHub image namespace 2020-04-08 09:14:03 +02:00
Renovate Bot
e13fbcb36b chore(deps): add renovate.json 2020-03-15 00:06:57 +01:00
Alex Viscreanu
6c131bc4a8 feat: Allow stripping tag prefixes 2020-02-24 22:11:13 +01:00
Alex Viscreanu
4a68ad0e14 fix: Strip refs/tags string from github ref 2020-02-17 00:11:52 +01:00
8 changed files with 64 additions and 38 deletions

View File

@@ -8,4 +8,4 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Run commitsar
uses: docker://commitsar/commitsar
uses: docker://aevea/commitsar

View File

@@ -9,7 +9,7 @@ jobs:
- uses: actions/checkout@master
- name: GitHub Package Registry
uses: outillage/kaniko-action@master
uses: aevea/action-kaniko@master
with:
registry: docker.pkg.github.com
password: ${{ secrets.GITHUB_TOKEN }}
@@ -18,10 +18,10 @@ jobs:
cache_registry: cache
- name: Dockerhub
uses: outillage/kaniko-action@master
uses: aevea/action-kaniko@master
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
image: outillage/kaniko
image: aevea/kaniko
cache: true
cache_registry: outillage/cache
cache_registry: aevea/cache

View File

@@ -13,12 +13,12 @@ jobs:
uses: actions/checkout@v1
- name: Release Notary Action
uses: docker://commitsar/release-notary
uses: docker://aevea/release-notary
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: GitHub Package Registry
uses: outillage/kaniko-action@master
uses: aevea/action-kaniko@master
with:
registry: docker.pkg.github.com
password: ${{ secrets.GITHUB_TOKEN }}
@@ -27,10 +27,10 @@ jobs:
cache_registry: cache
- name: Dockerhub
uses: outillage/kaniko-action@master
uses: aevea/action-kaniko@master
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
image: outillage/kaniko
image: aevea/kaniko
cache: true
cache_registry: outillage/cache
cache_registry: aevea/cache

View File

@@ -4,5 +4,5 @@ COPY entrypoint.sh /
ENTRYPOINT ["/entrypoint.sh"]
LABEL repository="https://github.com/outillage/action-kaniko" \
LABEL repository="https://github.com/aevea/action-kaniko" \
maintainer="Alex Viscreanu <alexviscreanu@gmail.com>"

View File

@@ -19,13 +19,13 @@ jobs:
steps:
- uses: actions/checkout@master
- name: Kaniko build
uses: outillage/kaniko-action@master
uses: aevea/action-kaniko@master
with:
image: outillage/kaniko
image: aevea/kaniko
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
cache: true
cache_registry: outillage/cache
cache_registry: aevea/cache
```
## Required Arguments
@@ -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**
@@ -61,7 +62,7 @@ In this case, the authentication credentials need to be passed via GitHub Action
```yaml
with:
image: outillage/kaniko
image: aevea/kaniko
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
```
@@ -71,17 +72,17 @@ doesn't work. If you want to use caching with Dockerhub, create a `cache` reposi
```yaml
with:
image: outillage/kaniko
image: aevea/kaniko
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
cache: true
cache_registry: outillage/cache
cache_registry: aevea/cache
```
### [docker.pkg.github.com](https://github.com/features/packages)
GitHub's docker registry is a bit special. It doesn't allow top-level images, so this action will prefix any image with the GitHub namespace.
If you want to push your image like `outillage/kaniko-action/kaniko`, you'll only need to pass `kaniko` to this action.
If you want to push your image like `aevea/action-kaniko/kaniko`, you'll only need to pass `kaniko` to this action.
The authentication is automatically done using the `GITHUB_ACTOR` and `GITHUB_TOKEN` provided from GitHub itself. But as `GITHUB_TOKEN` is not
passed by default, it will have to be explicitly set up.
@@ -124,7 +125,7 @@ with:
registry: registry.gitlab.com
username: ${{ secrets.GL_REGISTRY_USERNAME }}
password: ${{ secrets.GL_REGISTRY_PASSWORD }}
image: outillage/kaniko
image: aevea/kaniko
```
> NOTE: As GitLab's registry does support namespacing, Kaniko can natively push cached layers to it, so only `cache: true` is necessary to be
@@ -135,7 +136,7 @@ with:
registry: registry.gitlab.com
username: ${{ secrets.GL_REGISTRY_USERNAME }}
password: ${{ secrets.GL_REGISTRY_PASSWORD }}
image: outillage/kaniko
image: aevea/kaniko
cache: true
```
@@ -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.

View File

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

View File

@@ -3,9 +3,10 @@ set -e pipefail
export REGISTRY=${INPUT_REGISTRY:-"docker.io"}
export IMAGE=${INPUT_IMAGE}
export BRANCH=$(echo ${GITHUB_REF} | sed -e "s/refs\/heads\///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=${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
@@ -24,10 +25,11 @@ sanitize "${IMAGE}" "image"
sanitize "${TAG}" "tag"
if [ "$REGISTRY" == "docker.pkg.github.com" ]; then
export IMAGE="$GITHUB_REPOSITORY/$IMAGE"
IMAGE_NAMESPACE="$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')"
export IMAGE="$IMAGE_NAMESPACE/$IMAGE"
if [ ! -z $INPUT_CACHE_REGISTRY ]; then
export INPUT_CACHE_REGISTRY="$REGISTRY/$GITHUB_REPOSITORY/$INPUT_CACHE_REGISTRY"
export INPUT_CACHE_REGISTRY="$REGISTRY/$IMAGE_NAMESPACE/$INPUT_CACHE_REGISTRY"
fi
fi

5
renovate.json Normal file
View File

@@ -0,0 +1,5 @@
{
"extends": [
"config:base"
]
}