From 8f1c0eb82b4949b5d27c97544f137bed43106588 Mon Sep 17 00:00:00 2001 From: Henrik Gerdes Date: Fri, 22 Dec 2023 23:45:58 +0100 Subject: [PATCH] docs: update readme --- .gitignore | 1 + README.md | 19 ++++++++++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..722d5e7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.vscode diff --git a/README.md b/README.md index 9b65d4e..eb9f1ea 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# Container Build Kaniko +# GitLab CI/CD Components +![CI/CD](https://gitlab.com/hegerdes/gitlab-actions/badges/main/pipeline.svg) +![Release](https://gitlab.com/hegerdes/gitlab-actions/-/badges/release.svg) -## Usage +This repo contains a collection of different [GotLab CI/CD Components](https://about.gitlab.com/blog/2023/12/21/introducing-the-gitlab-ci-cd-catalog-beta/). -Use this component to enable container scanning in your project. +Currently suporrted are: + * [Container Build: Kaniko](https://gitlab.com/hegerdes/gitlab-actions#container-build-kaniko) + +## Container Build: Kaniko + +### Usage + +Use this component to build container images in your project without the need of a privileged Docker runner. It uses Googles [kaniko](https://github.com/GoogleContainerTools/kaniko) project to allow safe image builds in Docker or Kubernetes. It automataticly adds metadata labels to the image for easy tracking when the image is deployed. You should add this component to an existing `.gitlab-ci.yml` file by using the `include:` keyword. @@ -11,9 +20,9 @@ include: - component: gitlab.com/hegerdes/gitlab-actions/container-build@ ``` -where `` is the latest released tag or `main`. +where `` is the latest released tag or `main`. This will add a `container_build` job to the pipeline. +*NOTE:* By default the latest version of kaniko is used. For a more predictable outcome you should pin the version to a specific tag via the `build_image` input. -This will add a `container_build` job to the pipeline. The template should work without modifications but you can customize the template settings. ### Inputs