Skip to content

Commit

Permalink
Removed unused prowjob scenario docs. (#12142)
Browse files Browse the repository at this point in the history
* Removed unused prowjob scenario docs.
Removed limited tags on pr images notice.

* Removed docs for prowjob usage. This is not used anymore.
Added more details about default tags.
Removed notice about limits in default tags.

* Apply suggestions from code review

Co-authored-by: Iwona Langer <iwona.langer@sap.com>

---------

Co-authored-by: Iwona Langer <iwona.langer@sap.com>
  • Loading branch information
dekiel and IwonaLanger authored Oct 16, 2024
1 parent 5e3fb3e commit 20895fe
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 328 deletions.
42 changes: 24 additions & 18 deletions cmd/image-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Key features:
* Supports signing images with signify service
* Supports pushing images to the Google Cloud Artifact Registry

> [!NOTE]
> For more information on Image Builder usage in ProwJobs, see [README_deprecated.md](./README_deprecated.md).
## Quickstart Guide

You can use Image Builder in your GitHub workflow to build an image in an SLC-29-compliant system.
Expand Down Expand Up @@ -119,6 +116,29 @@ See the accepted inputs description in the [image-builder reusable workflow](/.g
The Image Builder reusable workflow provides outputs to pass the results of the build process.
See the provided outputs description in the [image-builder reusable workflow](/.github/workflows/image-builder.yml) file.

## Default Tags

Image Builder provides default tags for built images.
The default tag is computed based on the template provided in the Image Builder configuration file.
The default tag is always added to the image, even if the user provides custom tags.
Image Builder supports two default tags:

- **Pull Request Default Tag**: The default tag template for images built on pull requests is `pr-<PR_NUMBER>`.
Example tag value: `PR-123`.
- **Push Default Tag**: The default tag template for images built on push, schedule and manual triggers is `v<DATE>-<SHORT_SHA>`.
Example tag value: `v20210930-1234567`.

## Named Tags

Image Builder supports passing the name along with the tag, using both the `-tag` option and the config for the tag template.
You can use `-tag name=value` to pass the name for the tag.

If the name is not provided, it is evaluated from the value:

- If the value is a string, it is used directly as a name. For example,`-tag latest` is equal to `-tag latest=latest`
- If the value is go-template, it is converted to a valid name. For example, `-tag v{{ .ShortSHA }}-{{ .Date }}` is equal
to `-tag vShortSHA-Date=v{{ .ShortSHA }}-{{ .Date }}`

## Supported Image Repositories

Image Builder supports pushing images to the Google Cloud Artifact registries.
Expand Down Expand Up @@ -169,20 +189,6 @@ The Signify API's structure has also been updated. For more information, see the

The JSON structure for signing has changed. See the new structure and examples in the [Signify API Documentation](https://pages.github.tools.sap/Repository-Services/Signify/how_to/manage_signatures/).


## Named Tags

Image Builder supports passing the name along with the tag, using both the `-tag` option and the config for the tag template.
You can use `-tag name=value` to pass the name for the tag.

If the name is not provided, it is evaluated from the value:
- if the value is a string, it is used as a name directly. For example,`-tag latest` is equal to `-tag latest=latest`
- if the value is go-template, it will be converted to a valid name. For example, `-tag v{{ .ShortSHA }}-{{ .Date }}` is equal to `-tag vShortSHA-Date=v{{ .ShortSHA }}-{{ .Date }}`

> [!Note]
> When running on the `pull_request_target` event, Image Builder ignores additional tags provided with tags input.
> The image will be tagged only with the default PR-<PR_NUMBER> tag.

## Environment File

The environment file contains environment variables to be loaded in the build.
Expand All @@ -192,4 +198,4 @@ The file must be in the format of `key=value` pairs, separated by newlines.

Image Builder uses the ADO `oci-image-builder` pipeline as a build backend.
That means the images are built, signed and pushed to the Google Cloud Artifact registry in the ADO pipeline.
Image Builder does not build images locally on GitHub runners.
Image Builder does not build images locally on GitHub runners.
306 changes: 0 additions & 306 deletions cmd/image-builder/README_deprecated.md

This file was deleted.

5 changes: 1 addition & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

[Image Builder](/cmd/image-builder/README.md) - Image Builder is a tool for building OCI-compliant images in an SLC-29-compliant system from a GitHub workflow.

[Image Builder](/cmd/image-builder/README_deprecated.md) - > Deprecation Notice

[Image Builder GitHub Workflow Integration](/cmd/image-builder/github-workflow-integration.md) - The Image Builder solution integrates with GitHub workflows and uses an Azure DevOps pipeline to run the process of building OCI

[Image Builder](/cmd/image-builder/image-builder.md) - Image Builder is a tool for building OCI-compliant images.
Expand Down Expand Up @@ -88,5 +86,4 @@

[Images](/prow/images/README.md) - > DEPRECATED: Use the [`images`](/images) directory instead.

[Vulnerability Scanner](/prow/images/whitesource-scanner/README.md) - This folder contains the WhiteSource Unified Agent image that is based on the Java Buildpack image. Use it to perform WhiteSource vulnerability scans.

[Vulnerability Scanner](/prow/images/whitesource-scanner/README.md) - This folder contains the WhiteSource Unified Agent image that is based on the Java Buildpack image. Use it to perform WhiteSource vulnerability scans.

0 comments on commit 20895fe

Please sign in to comment.