self-hosted/gitlab-actions
1
0
Fork 0
mirror of https://github.com/hegerdes/gitlab-actions.git synced 2025-10-06 05:36:52 +02:00
Code Activity

docs: update readme

Browse Source
This commit is contained in:
Henrik Gerdes
2023-12-22 23:45:58 +01:00
parent f3f7f2edc2
commit 8f1c0eb82b
2 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.vscode

19
README.md
View File

@@ -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:` You should add this component to an existing `.gitlab-ci.yml` file by using the `include:`
keyword. keyword.
@@ -11,9 +20,9 @@ include:
- component: gitlab.com/hegerdes/gitlab-actions/container-build@<VERSION> - component: gitlab.com/hegerdes/gitlab-actions/container-build@<VERSION>
``` ```
where `<VERSION>` is the latest released tag or `main`. where `<VERSION>` 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. The template should work without modifications but you can customize the template settings.
### Inputs ### Inputs