Squashing commits

.github/AL-Go-Settings.json

@@ -1,61 +1,62 @@
-{
-    "type":  "PTE",
-    "templateUrl":  "https://github.com/microsoft/AL-Go-PTE@preview",
-    "bcContainerHelperVersion":  "preview",
-    "runs-on":  "windows-latest",
-    "cacheImageName":  "",
-    "UsePsSession":  false,
-    "artifact": "https://bcinsider.azureedge.net/sandbox/24.0.14985.0/base",
-    "country":  "base",
-    "useProjectDependencies":  true,
-    "repoVersion":  "24.0",
-    "cleanModePreprocessorSymbols":  [
-                                         "CLEAN17",
-                                         "CLEAN18",
-                                         "CLEAN19",
-                                         "CLEAN20",
-                                         "CLEAN21",
-                                         "CLEAN22",
-                                         "CLEAN23",
-                                         "CLEAN24"
-                                     ],
-    "unusedALGoSystemFiles":  [
-                                  "AddExistingAppOrTestApp.yaml",
-                                  "CreateApp.yaml",
-                                  "CreateOnlineDevelopmentEnvironment.yaml",
-                                  "CreatePerformanceTestApp.yaml",
-                                  "CreateRelease.yaml",
-                                  "CreateTestApp.yaml",
-                                  "Current.yaml",
-                                  "IncrementVersionNumber.yaml",
-                                  "NextMajor.yaml",
-                                  "NextMinor.yaml",
-                                  "PublishToEnvironment.yaml",
-                                  "Test Current.settings.json"
-                              ],
-    "excludeEnvironments":  [
-                                "Official-Build"
-                            ],
-    "buildModes":  [
-                       "Translated"
-                   ],
-    "CICDPushBranches":  [
-                             "main"
-                         ],
-    "CICDPullRequestBranches":  [
-                                    "main"
-                                ],
-    "enableCodeCop":  true,
-    "enableAppSourceCop":  true,
-    "enablePerTenantExtensionCop":  true,
-    "enableUICop":  true,
-    "rulesetFile":  "..\\..\\..\\Apps\\rulesets\\app.ruleset.json",
-    "skipUpgrade":  true,
-    "fullBuildPatterns":  [
-                              "Build/*",
-                              "src/rulesets/*",
-                              ".github/workflows/PullRequestHandler.yaml",
-                              ".github/workflows/_BuildALGoProject.yaml"
-                          ],
-    "PullRequestTrigger":  "pull_request"
-}
+{
+    "type":  "PTE",
+    "templateUrl":  "https://github.com/microsoft/AL-Go-PTE@preview",
+    "bcContainerHelperVersion":  "preview",
+    "runs-on":  "windows-latest",
+    "cacheImageName":  "",
+    "UsePsSession":  false,
+    "artifact":  "https://bcinsider.azureedge.net/sandbox/25.0.17516.0/base",
+    "country":  "base",
+    "useProjectDependencies":  true,
+    "repoVersion":  "25.0",
+    "cleanModePreprocessorSymbols":  [
+                                         "CLEAN17",
+                                         "CLEAN18",
+                                         "CLEAN19",
+                                         "CLEAN20",
+                                         "CLEAN21",
+                                         "CLEAN22",
+                                         "CLEAN23",
+                                         "CLEAN24"
+                                     ],
+    "unusedALGoSystemFiles":  [
+                                  "AddExistingAppOrTestApp.yaml",
+                                  "CreateApp.yaml",
+                                  "CreateOnlineDevelopmentEnvironment.yaml",
+                                  "CreatePerformanceTestApp.yaml",
+                                  "CreateRelease.yaml",
+                                  "CreateTestApp.yaml",
+                                  "Current.yaml",
+                                  "IncrementVersionNumber.yaml",
+                                  "NextMajor.yaml",
+                                  "NextMinor.yaml",
+                                  "PublishToEnvironment.yaml",
+                                  "Test Current.settings.json"
+                              ],
+    "excludeEnvironments":  [
+                                "Official-Build"
+                            ],
+    "buildModes":  [
+                       "Translated"
+                   ],
+    "CICDPushBranches":  [
+                             "main"
+                         ],
+    "CICDPullRequestBranches":  [
+                                    "main"
+                                ],
+    "enableCodeCop":  true,
+    "enableAppSourceCop":  true,
+    "enablePerTenantExtensionCop":  true,
+    "enableUICop":  true,
+    "rulesetFile":  "..\\..\\..\\Build\\rulesets\\app.ruleset.json",
+    "skipUpgrade":  true,
+    "fullBuildPatterns":  [
+                              "Build/*",
+                              ".github/workflows/PullRequestHandler.yaml",
+                              ".github/workflows/_BuildALGoProject.yaml"
+                          ],
+    "UpdateALGoSystemFilesEnvironment":  "Official-Build",
+    "PullRequestTrigger":  "pull_request",
+    "templateSha":  "0476547896ebcd3ba5455b3e0e59b48c0d4a26ca"
+}

.github/ISSUE_TEMPLATE/bcidea.yaml

@@ -1,5 +1,5 @@
-name: Suggest a feature for contribution
-description: Suggest a feature you would like to implement, which is based on a BC idea.
+name: Implement a BC Idea
+description: Suggest a BC Idea you would like to implement.
 title: "[BC Idea]: "
 labels: ["bcidea"]
 body:
@@ -32,3 +32,12 @@ body:
       placeholder: Description of BC Idea
     validations:
       required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: I will provide the implementation for this BC Idea
+      description: | 
+        To provide the implementation for a BC idea, select this checkbox and then Get started. Thanks for contributing. 
+      options:
+        - label: I will provide the implementation for this BC Idea
+          required: true

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,4 +1,4 @@
-name: Report and address a bug
+name: Fix a bug
 description: Create a bug report for a product defect you would like to address yourself
 title: "[Bug]: "
 labels: ["bug"]
@@ -47,4 +47,13 @@ body:
       description: If needed add any other context about the problem here or include screenshots
       placeholder: Additional context, screenshots, log output, etc.
     validations:
-      required: true
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: I will provide a fix for a bug
+      description: | 
+        To provide a fix for a bug, select this checkbox and then Get started. Thanks for contributing. 
+      options:
+        - label: I will provide a fix for a bug
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
 blank_issues_enabled: false
 contact_links:
   - name: Request a feature
-    url: http://aka.ms/bcideas
-    about: Please go to http://aka.ms/bcideas to log your idea. Creating an issue here is not the right way.
-  - name: Report a bug which has customer impact
-    url: http://aka.ms/bcsupport
-    about: Please follow the steps on http://aka.ms/bcsupport to get support. Creating an issue here is not the right way.
+    url: https://aka.ms/bcideas
+    about: Please go to https://aka.ms/bcideas to log your idea. Creating an issue here is not the right way.
+  - name: Report a bug
+    url: https://aka.ms/bcsupport?#bugs
+    about: Please follow the steps on https://aka.ms/bcsupport to get support. Creating an issue here is not the right way.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+<!-- Thank you for submitting a Pull Request. If you're new to contributing to AlAppExtensions please read our pull request guideline below
+* https://github.com/microsoft/ALAppExtensions/blob/main/CONTRIBUTING.md
+-->
+#### Summary <!-- Provide a general summary of your changes -->
+
+#### Work Item(s) <!-- Add the issue number here after the #. The issue needs to be open and approved. Submitting PRs with no linked issues or unapproved issues is highly discouraged. -->
+Fixes #

.github/RELEASENOTES.copy.md

@@ -2,6 +2,59 @@
 
 Note that when using the preview version of AL-Go for GitHub, we recommend you Update your AL-Go system files, as soon as possible when informed that an update is available.
 
+### New Settings
+- `UpdateALGoSystemFilesEnvironment`: The name of the environment that is referenced in job `UpdateALGoSystemFiles` in the _Update AL-Go System Files_ workflow. See [jobs.<job_id>.environment](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenvironment) for more information. Currently, only setting the environment name is supported.
+
+### Issues
+- Support release branches that start with releases/
+
+### Build modes 
+AL-Go ships with Default, Translated and Clean mode out of the box. Now you can also define custom build modes in addition to the ones shipped with AL-Go. This allows you to define your own build modes, which can be used to build your apps in different ways. By default, a custom build mode will build the apps similarly to the Default mode but this behavior can be overridden in e.g. script overrides in your repository.  
+
+## v4.1
+
+### New Settings
+- `templateSha`: The SHA of the version of AL-Go currently used
+
+### New Actions
+- `DumpWorkflowInfo`: Dump information about running workflow
+- `Troubleshooting` : Run troubleshooting for repository
+
+### Update AL-Go System Files
+Add another parameter when running Update AL-Go System Files, called downloadLatest, used to indicate whether to download latest version from template repository. Default value is true.
+If false, the templateSha repository setting is used to download specific AL-Go System Files when calculating new files.
+
+### Issues
+- Issue 782 Exclude '.altestrunner/' from template .gitignore
+- Issue 823 Dependencies from prior build jobs are not included when using useProjectDependencies
+- App artifacts for version 'latest' are now fetched from the latest CICD run that completed and successfully built all the projects for the corresponding branch.
+- Issue 824 Utilize `useCompilerFolder` setting when creating an development environment for an AL-Go project.
+- Issue 828 and 825 display warnings for secrets, which might cause AL-Go for GitHub to malfunction
+
+### New Settings
+
+- `alDoc` : JSON object with properties for the ALDoc reference document generation
+  - **continuousDeployment** = Determines if reference documentation will be deployed continuously as part of CI/CD. You can run the **Deploy Reference Documentation** workflow to deploy manually or on a schedule. (Default false)
+  - **deployToGitHubPages** = Determines whether or not the reference documentation site should be deployed to GitHub Pages for the repository. In order to deploy to GitHub Pages, GitHub Pages must be enabled and set to GitHub Actions. (Default true)
+  - **maxReleases** = Maximum number of releases to include in the reference documentation. (Default 3)
+  - **groupByProject** = Determines whether projects in multi-project repositories are used as folders in reference documentation
+  - **includeProjects** = An array of projects to include in the reference documentation. (Default all)
+  - **excludeProjects** = An array of projects to exclude in the reference documentation. (Default none)-
+  - **header** = Header for the documentation site. (Default: Documentation for...)
+  - **footer** = Footer for the documentation site. (Default: Made with...)
+  - **defaultIndexMD** = Markdown for the landing page of the documentation site. (Default: Reference documentation...)
+  - **defaultReleaseMD** = Markdown for the landing page of the release sites. (Default: Release reference documentation...)
+  - *Note that in header, footer, defaultIndexMD and defaultReleaseMD you can use the following placeholders: {REPOSITORY}, {VERSION}, {INDEXTEMPLATERELATIVEPATH}, {RELEASENOTES}* 
+
+### New Workflows
+- **Deploy Reference Documentation** is a workflow, which you can invoke manually or on a schedule to generate and deploy reference documentation using the aldoc tool, using the ALDoc setting properties described above.
+- **Troubleshooting** is a workflow, which you can invoke manually to run troubleshooting on the repository and check for settings or secrets, containing illegal values. When creating issues on https://github.com/microsoft/AL-Go/issues, we might ask you to run the troubleshooter to help identify common problems.
+
+### Support for ALDoc reference documentation tool
+ALDoc reference documentation tool is now supported for generating and deploying reference documentation for your projects either continuously or manually/scheduled.
+
+## v4.0
+
 ### Removal of the InsiderSasToken
 
 As of October 1st 2023, Business Central insider builds are now publicly available. When creating local containers with the insider builds, you will have to accept the insider EULA (https://go.microsoft.com/fwlink/?linkid=2245051) in order to continue.