Enable external rulesets (#733)

Fix for issue #730 --------- Co-authored-by: freddydk <freddydk@users.noreply.github.com>
microsoft · Sep 29, 2023 · b47f003 · b47f003
1 parent 54737c2
commit b47f003
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 0 deletions.
diff --git a/Actions/AL-Go-Helper.ps1 b/Actions/AL-Go-Helper.ps1
@@ -586,6 +586,7 @@ function ReadSettings {
         "failOn"                                        = "error"
         "treatTestFailuresAsWarnings"                   = $false
         "rulesetFile"                                   = ""
+        "enableExternalRulesets"                        = $false
         "vsixFile"                                      = ""
         "assignPremiumPlan"                             = $false
         "enableTaskScheduler"                           = $false
@@ -1860,6 +1861,7 @@ function CreateDevEnv {
             -failOn $settings.failOn `
             -treatTestFailuresAsWarnings:$settings.treatTestFailuresAsWarnings `
             -rulesetFile $settings.rulesetFile `
+            -enableExternalRulesets:$settings.enableExternalRulesets `
             -AppSourceCopMandatoryAffixes $settings.appSourceCopMandatoryAffixes `
             -obsoleteTagMinAllowedMajorMinor $settings.obsoleteTagMinAllowedMajorMinor `
             -doNotRunTests `

diff --git a/Actions/RunPipeline/RunPipeline.ps1 b/Actions/RunPipeline/RunPipeline.ps1
@@ -400,6 +400,7 @@ try {
         -failOn $settings.failOn `
         -treatTestFailuresAsWarnings:$settings.treatTestFailuresAsWarnings `
         -rulesetFile $settings.rulesetFile `
+        -enableExternalRulesets:$settings.enableExternalRulesets `
         -appSourceCopMandatoryAffixes $settings.appSourceCopMandatoryAffixes `
         -additionalCountries $additionalCountries `
         -obsoleteTagMinAllowedMajorMinor $settings.obsoleteTagMinAllowedMajorMinor `

diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -8,6 +8,13 @@ As of October 1st 2023, Business Central insider builds are now publicly availab
 
 AL-Go for GitHub allows you to build and test using insider builds without any explicit approval, but please note that the insider artifacts contains the insider Eula and you automatically accept this when using the builds.
 
+### Issues
+- Issue 730 Support for external rulesets.
+
+### New Settings
+- `enableExternalRulesets`: set this setting to true if you want to allow AL-Go to automatically download external references in rulesets.
+
+
 ## v3.3
 
 ### Issues

diff --git a/Scenarios/MigrateFromAzureDevOpsWithHistory.md b/Scenarios/MigrateFromAzureDevOpsWithHistory.md
@@ -34,6 +34,7 @@
     - enableCodeCop, see https://aka.ms/algosettings#enableCodeCop
     - enableUICop, see https://aka.ms/algosettings#enableUICop
     - rulesetFile, see https://aka.ms/algosettings#rulesetFile
+    - enableExternalRulesets, see https://aka.ms/algosettings#enableExternalRulesets
     - runNumberOffset, see https://aka.ms/algosettings#runNumberOffset
 
     Also, if you are migrating an AppSource App, you will need to create a secret called LicenseFileUrl, which should contain a secure direct download URL to your license file, as mentioned [here](SetupCiCdForExistingAppSourceApp.md).

diff --git a/Scenarios/MigrateFromAzureDevOpsWithoutHistory.md b/Scenarios/MigrateFromAzureDevOpsWithoutHistory.md
@@ -24,6 +24,7 @@
     - enableCodeCop, see https://aka.ms/algosettings#enableCodeCop
     - enableUICop, see https://aka.ms/algosettings#enableUICop
     - rulesetFile, see https://aka.ms/algosettings#rulesetFile
+    - enableExternalRulesets, see https://aka.ms/algosettings#enableExternalRulesets
     - runNumberOffset, see https://aka.ms/algosettings#runNumberOffset
 
     Also, if you are migrating an AppSource App, you will need to create a secret called LicenseFileUrl, which should contain a secure direct download URL to your license file, as mentioned [here](SetupCiCdForExistingAppSourceApp.md).

diff --git a/Scenarios/settings.md b/Scenarios/settings.md
@@ -89,6 +89,7 @@ The repository settings are only read from the repository settings file (.github
 | <a id="customCodeCops"></a>customCodeCops | CustomCodeCops is an array of paths or URLs to custom Code Cop DLLs you want to enable when building. | [ ] |
 | <a id="failOn"></a>failOn | Specifies what the pipeline will fail on. Allowed values are none, warning and error | error |
 | <a id="rulesetFile"></a>rulesetFile | Filename of the custom ruleset file | |
+| <a id="enableExternalRulesets"></a>enableExternalRulesets | If enableExternalRulesets is set to true, then you can have external rule references in the ruleset | false |
 | <a id="vsixFile"></a>vsixFile | A direct download URL, pointing to the AL Language VSIX file to use for building the apps. By default, AL-Go uses the AL Language extension, which is shipped with the artifacts used for the build. | |
 | <a id="codeSignCertificateUrlSecretName"></a>codeSignCertificateUrlSecretName<br />codeSignCertificatePasswordSecretName | When developing AppSource Apps, your app needs to be code signed and you need to add secrets to GitHub secrets or Azure KeyVault, specifying the secure URL from which your codesigning certificate pfx file can be downloaded and the password for this certificate. These settings specifies the names (**NOT the secrets**) of the code signing certificate url and password. Default is to look for secrets called CodeSignCertificateUrl and CodeSignCertificatePassword. Read [this](SetupCiCdForExistingAppSourceApp.md) for more information. | CodeSignCertificateUrl<br />CodeSignCertificatePassword |
 | <a id="keyVaultCodesignCertificateName"></a>keyVaultCodesignCertificateName | Name of a certificate stored in your KeyVault that can be used to codesigning. To use this setting you will also need enable Azure KeyVault in your AL-GO project. Read [this](UseAzureKeyVault.md) for more information | |