Skip to content

Commit

Permalink
docs: update link to full metafile documentation and optional field r…
Browse files Browse the repository at this point in the history
…epoCategory
  • Loading branch information
FaGru3n committed Jan 11, 2024
1 parent 0a562e0 commit 1831649
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/release/trg-2/trg-2-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ We aim to have automatic quality checks and therefore need a metadata file to id

## Description

To enable automatic analysis of repositories, all repositories **MUST** have a file named `.tractusx` present on root-level with the dedicated `repoCategory` which points to the displayed section for the repository.
To enable automatic analysis of repositories, all repositories **MUST** have a file named `.tractusx` present on root-level.
This file needs to contain metadata about the repository and product in a YAML format.
The mandatory declarations in the `.tractusx` metadata file do vary for leading- and non-leading repositories.

Detailed documentation on the content of the `.tractusx` metadata file can be found [in the quality check docs](https://github.com/eclipse-tractusx/tractusx-quality-checks/blob/main/docs/metadata_file.md).
Detailed documentation on the content of the `.tractusx` metadata file can be found [in the quality check docs](https://github.com/eclipse-tractusx/sig-release/blob/main/docs/metadata_file.md).

The result of the automated repository checks depending on the `.tractusx` metadata file can be found on the [quality checks dashboard](https://eclipse-tractusx.github.io/sig-release)

Expand All @@ -31,7 +31,7 @@ Example `.tractusx` file taken from the docs:
product: "your-product-name"
# mandatory info in every repo
leadingRepository: "https://github.com/eclipse-tractusx/<your-leading-repo>"
# default: available options: "special", "support"; optional field. will be treated as regular product repo without entry
# optional field by default it will be treated as regular product repo. Available options: "special" , "support".
repoCategory: "special"
# optional section to refer to all of your teams repositories
repositories:
Expand Down

0 comments on commit 1831649

Please sign in to comment.