Skip to content

Commit 67b8ecb

Browse files
Updated comments
1 parent 2ec7a3d commit 67b8ecb

File tree

2 files changed

+4
-10
lines changed

2 files changed

+4
-10
lines changed

README.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,18 @@ The **Skyline.DataMiner.CICD.Tools.GitHubToCatalogYaml** tool automates the crea
2525

2626
**WARNING! DO NOT MODIFY THIS FILE.**
2727

28-
This tool generates an `auto-generated-catalog.yml` file in the `.githubtocatalog` directory, alongside extending any existing `catalog.yml` or `manifest.yml` file. This secondary file is critical for the following reasons:
28+
This tool generates an `auto-generated-catalog.yml` file in the `.githubtocatalog` directory, alongside extending any existing `catalog.yml` or `manifest.yml` file. This auto-generated file is critical for the following reasons:
2929

3030
1. **Tracking Catalog IDs:**
3131
Committing and pushing the `auto-generated-catalog.yml` allows the tool to create a unique Catalog ID on the first run and reuse it for future runs. This prevents duplicate catalog records, which can occur if new IDs are generated with each workflow run.
3232

3333
2. **Workflow Automation:**
3434
The `auto-generated-catalog.yml` is maintained separately, enabling other processes to access it without modifying the primary catalog file during updates.
3535

36-
37-
3836
## **Primary Catalog YAML File**
3937

40-
If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by:
41-
42-
- Creating a new `catalog.yml` file in the root of your repository and including only the modifications you want.
43-
- Alternatively, duplicating the entire `auto-generated-catalog.yml` file to the root of your repository and making adjustments as needed.
38+
If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by creating a `catalog.yml` file in the root of your repository.
39+
This file does not have to contain all the fields, only the ones you wish to change will suffice.
4440

4541
## Inferring Catalog Item Type
4642

Skyline.DataMiner.CICD.Tools.GitHubToCatalogYaml/CatalogYaml.cs

+1-3
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,7 @@ public class CatalogYaml
5454
" Cannot contain leading or trailing whitespace characters.";
5555

5656
private const string typeComment = "WARNING! DO NOT CHANGE THIS FILE.\r\n" +
57-
"Overriding or extending this file can be done by:\r\n" +
58-
" - creating a new catalog.yml file in the root of your repository and writing only the things you want to adjust in there.\r\n" +
59-
" - You may also duplicate this entire file to the root of your repository and then adjust what you want.\r\n\r\n" +
57+
"If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by creating a `catalog.yml` file in the root of your repository.\r\n\r\n" +
6058
"[Required]\r\n" +
6159
"Possible values for the Catalog item that can be deployed on a DataMiner System:\r\n" +
6260
" - automationscript: If the Catalog item is a general-purpose DataMiner Automation script.\r\n" +

0 commit comments

Comments
 (0)