From f6f62bb9435d00be3ebba67ed3e2fae0a4ad8143 Mon Sep 17 00:00:00 2001 From: Freddy Kristiansen Date: Tue, 27 Aug 2024 10:39:09 +0200 Subject: [PATCH] Add projects to docs (#1181) Fixes #1180 Add projects to repository settings and remove appFolders, testFolder and bcptTestFolders (which are also described under basic project settings. --------- Co-authored-by: freddydk --- Scenarios/settings.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Scenarios/settings.md b/Scenarios/settings.md index 3a9753c23..72297b761 100644 --- a/Scenarios/settings.md +++ b/Scenarios/settings.md @@ -52,12 +52,10 @@ The repository settings are only read from the repository settings file (.github | Name | Description | | :-- | :-- | -| type | Specifies the type of project. Allowed values are **PTE** or **AppSource App**. This value comes with the default repository. Default value is PTE. | -| appFolders | appFolders should be an array of folders (relative to project root), which contains apps for this project. Apps in these folders are sorted based on dependencies and built and published in that order.
If appFolders are not specified, AL-Go for GitHub will try to locate appFolders in the root of the project. | -| testFolders | testFolders should be an array of folders (relative to project root), which contains test apps for this project. Apps in these folders are sorted based on dependencies and built, published and tests are run in that order.
If testFolders are not specified, AL-Go for GitHub will try to locate testFolders in the root of the project.| -| bcptTestFolders | bcptTestFolders should be an array of folders (relative to project root), which contains performance test apps for this project. Apps in these folders are sorted based on dependencies and built, published and bcpt tests are run in that order.
If bcptTestFolders are not specified, AL-Go for GitHub will try to locate bcptTestFolders in the root of the project. | +| type | Specifies the type of repository. Allowed values are **PTE** or **AppSource App**. This value comes with the default repository. Default value is PTE. | +| projects | Specifies the list of projects in this repository (names of folders containing AL-Go projects). If not specified, AL-Go will **enumerate folders in the two levels under the root of the repository** for folders containing a `.AL-Go` folder with a `settings.json` file. | | powerPlatformSolutionFolder | Contains the name of the folder containing a PowerPlatform Solution (only one) | -| templateUrl | Defines the URL of the template repository used to create this project and is used for checking and downloading updates to AL-Go System files. | +| templateUrl | Defines the URL of the template repository used to create this repository and is used for checking and downloading updates to AL-Go System files. | | nextMajorSchedule | CRON schedule for when NextMajor workflow should run. Default is no scheduled run, only manual trigger. Build your CRON string here: [https://crontab.guru](https://crontab.guru). You need to run the Update AL-Go System Files workflow for the schedule to take effect. | | nextMinorSchedule | CRON schedule for when NextMinor workflow should run. Default is no scheduled run, only manual trigger. Build your CRON string here: [https://crontab.guru](https://crontab.guru). You need to run the Update AL-Go System Files workflow for the schedule to take effect. | | currentSchedule | CRON schedule for when Current workflow should run. Default is no scheduled run, only manual trigger. Build your CRON string here: [https://crontab.guru](https://crontab.guru). You need to run the Update AL-Go System Files workflow for the schedule to take effect. |