Skip to content

Commit 3d02f59

Browse files
nazarovdoamvasilyev
authored andcommitted
Updated documentation with generate_repository_config.yaml and scanning mode description (refs FRUC-194)
1 parent 689ad93 commit 3d02f59

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/src/commands/generate-product-repositories.md

+26
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,31 @@ If you only need to generate a specific product with a specific version, use the
1313
```
1414
./mdbci generate-product-repositories --product mariadb --product-version 10.6
1515
```
16+
1617
You should run this command regularly to keep up with the latest changes in the repositories of the products, supported by MDBCI.
1718
[Full list products](../products/all_products.md)
19+
20+
### Configuration
21+
The configuration for generating the repo.d is defined in the `config/generate_repository_config.yaml` file. This file contains the remote repos URLs and additional parameters.
22+
23+
You can set the remote repository scanning mode for each product by using the `scan_mode` attribute in the `generate_repository_config.yaml` file. There are two modes to choose from:
24+
25+
- `use-all-links`: the product parser will scan all accessible directories in the remote repository recursively. This means it will explore every directory it can find within the repository.
26+
- `follow-only-sublinks`: the product parser will limit its scanning to directories that are direct sublinks of the main remote repository URL. In other words, it will only visit those directories that can be reached directly from the parent URL.
27+
28+
#### Example
29+
Main repository URL:
30+
```
31+
https://dlm.repo.org/
32+
```
33+
Product release URL (sublink of base version URL):
34+
```
35+
https://dlm.repo.org/product/1.0/1.0.1-debug
36+
```
37+
This URL is considered a sublink because it falls under the base version 1.0 directory in the main repository.
38+
39+
Product release URL (not a sublink of base version URL):
40+
```
41+
https://dlm.repo.org/product/1.0.1-debug
42+
```
43+
This URL is not a sublink since it does not reside within a recognized directory structure of the parent directory.

0 commit comments

Comments
 (0)