Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Latest commit

 

History

History
90 lines (69 loc) · 3.77 KB

metadata_file.md

File metadata and controls

90 lines (69 loc) · 3.77 KB

The Tractus-X metadata file

The tractusx-quality-checks rely on a metadata file to read product information and configuration for the checks. The following section describe details like location, filename and the quality check configuration options, you can declare.

General metadata

  • Filename: .tractusx
  • Location: root of your repository

Every eclipse-tractusx repository is expected to have a .tractusx metadata file present. General metadata is only mandatory in the leading product repository though.

The structure for leading repository metadata is as follows:

# Will be used on dashboard etc. to refer to your product; only mandatory in the leading repo
product: "your-product-name"
# mandatory info in every repo
leadingRepository: "https://github.com/eclipse-tractusx/<your-leading-repo>"
# optional section to refer to all of your teams repositories
repositories:
  - name: "your-product-repo"
    usage: "Main documentation and release repo for <product>"
    url: "https://github.com/eclipse-tractusx/<your-leading-repo>"
  - name: "your-product-library"
    usage: "A library supporting <product>, that is released separately"
    url: "https://github.com/eclipse-tractusx/<your-product-lib>"

Repository category

There are release guidelines, that target specific repositories, like the leading one for example. In order to differentiate the repositories, a repoCategory can be set in the metadata file to clarify the role of the repository. The category is set like shown in the following snippet:

repoCategory: "special" # default: product; available options: "special", "support", "product"

Quality check configuration

The .tractusx metadata file does contain configuration options to specify treatment in regards to guideline checks.

Exclude Dockerfiles from aligned base image check (TRG 4.02)

As defined in TRG 4.02, all of our Docker images, that are published to DockerHub, have to be based on an aligned base image.

To mark a Docker image as non-published and therefor skipping the aligned base image check, you can add the path to the respective Dockerfile in a skipReleaseChecks.alignedBaseImage section.

Example:

# section to explicitly skip certain release guideline checks
skipReleaseChecks:
  # Skip TRG 4.02 aligned base images; Specify the complete path and filename to the dockerfile that is used to build
  # a non published Docker image. Path is treated relative to your repository root.
  alignedBaseImage:
    - "path/to/non-published/Dockerfile"
    - "path/to/Dockerfile/only/used/in/testing-pipeline/Dockerfile.ui-tests"

Full example

The following snippet shows a complete example of a .tractusx metadata file with all its options.

# Will be used on dashboard etc. to refer to your product; only mandatory in the leading repo
product: "your-product-name"
# mandatory info in every repo
leadingRepository: "https://github.com/eclipse-tractusx/<your-leading-repo>"
# default: product; available options: "special", "support", "product"
repoCategory: "special"
# optional section to refer to all of your teams repositories
repositories:
  - name: "your-product-repo"
    usage: "Main documentation and release repo for <product>"
    url: "https://github.com/eclipse-tractusx/<your-leading-repo>"
  - name: "your-product-library"
    usage: "A library supporting <product>, that is released separately"
    url: "https://github.com/eclipse-tractusx/<your-product-lib>"
# section to explicitly skip certain release guideline checks
skipReleaseChecks:
  alignedBaseImage:
    - "/path/to/non-published/Dockerfile"