Skip to content

Commit

Permalink
Add projects to docs (#1181)
Browse files Browse the repository at this point in the history
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 <freddydk@users.noreply.github.com>
  • Loading branch information
freddydk and freddydk authored Aug 27, 2024
1 parent 0f201ab commit f6f62bb
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions Scenarios/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,10 @@ The repository settings are only read from the repository settings file (.github

| Name | Description |
| :-- | :-- |
| <a id="type"></a>type | Specifies the type of project. Allowed values are **PTE** or **AppSource App**. This value comes with the default repository. Default value is PTE. |
| <a id="appFolders"></a>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.<br />If appFolders are not specified, AL-Go for GitHub will try to locate appFolders in the root of the project. |
| <a id="testFolders"></a>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.<br />If testFolders are not specified, AL-Go for GitHub will try to locate testFolders in the root of the project.|
| <a id="bcptTestFolders"></a>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.<br />If bcptTestFolders are not specified, AL-Go for GitHub will try to locate bcptTestFolders in the root of the project. |
| <a id="type"></a>type | Specifies the type of repository. Allowed values are **PTE** or **AppSource App**. This value comes with the default repository. Default value is PTE. |
| <a id="projects"></a>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. |
| <a id="powerPlatformSolutionFolder"></a>powerPlatformSolutionFolder | Contains the name of the folder containing a PowerPlatform Solution (only one) |
| <a id="templateUrl"></a>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. |
| <a id="templateUrl"></a>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. |
| <a id="nextMajorSchedule"></a>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. |
| <a id="nextMinorSchedule"></a>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. |
| <a id="currentSchedule"></a>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. |
Expand Down

0 comments on commit f6f62bb

Please sign in to comment.