Remove optional properties from "required" list in settings.schema.json

[cegekaJG]

Currently, the list of required properties for the settings.json file looks as follows:

AL-Go/Actions/.Modules/settings.schema.json

Lines 662 to 750 in 62f89da

	"required": [
	"type",
	"unusedALGoSystemFiles",
	"projects",
	"powerPlatformSolutionFolder",
	"country",
	"artifact",
	"companyName",
	"repoVersion",
	"repoName",
	"versioningStrategy",
	"runNumberOffset",
	"appBuild",
	"appRevision",
	"keyVaultName",
	"licenseFileUrlSecretName",
	"ghTokenWorkflowSecretName",
	"adminCenterApiCredentialsSecretName",
	"applicationInsightsConnectionStringSecretName",
	"keyVaultCertificateUrlSecretName",
	"keyVaultCertificatePasswordSecretName",
	"keyVaultClientIdSecretName",
	"keyVaultCodesignCertificateName",
	"codeSignCertificateUrlSecretName",
	"codeSignCertificatePasswordSecretName",
	"additionalCountries",
	"appDependencies",
	"projectName",
	"appFolders",
	"testDependencies",
	"testFolders",
	"bcptTestFolders",
	"installApps",
	"installTestApps",
	"installOnlyReferencedApps",
	"generateDependencyArtifact",
	"skipUpgrade",
	"applicationDependency",
	"updateDependencies",
	"installTestRunner",
	"installTestFramework",
	"installTestLibraries",
	"installPerformanceToolkit",
	"enableCodeCop",
	"enableUICop",
	"enableCodeAnalyzersOnTestApps",
	"customCodeCops",
	"failOn",
	"treatTestFailuresAsWarnings",
	"rulesetFile",
	"enableExternalRulesets",
	"vsixFile",
	"assignPremiumPlan",
	"enableTaskScheduler",
	"doNotBuildTests",
	"doNotRunTests",
	"doNotRunBcptTests",
	"doNotPublishApps",
	"doNotSignApps",
	"configPackages",
	"appSourceCopMandatoryAffixes",
	"deliverToAppSource",
	"obsoleteTagMinAllowedMajorMinor",
	"memoryLimit",
	"templateUrl",
	"templateSha",
	"templateBranch",
	"appDependencyProbingPaths",
	"useProjectDependencies",
	"runs-on",
	"shell",
	"githubRunner",
	"githubRunnerShell",
	"cacheImageName",
	"cacheKeepDays",
	"alwaysBuildAllProjects",
	"microsoftTelemetryConnectionString",
	"partnerTelemetryConnectionString",
	"sendExtendedTelemetryToMicrosoft",
	"environments",
	"buildModes",
	"useCompilerFolder",
	"pullRequestTrigger",
	"bcptThresholds",
	"fullBuildPatterns",
	"excludeEnvironments",
	"alDoc",
	"trustMicrosoftNuGetFeeds"
	]

Which is not only excessive, it's also wrong. Some properties like appDependencies will cause warnings if they are defined, but empty.
In my opinion, the schema should only require properties that are necessary to run actions given the sample app. Since not every action is needed for a project, I don't know how to determine whether a property should be required if it is necessary for a less used workflow, but at the very least those with default values should be removed from this list.

[jwikman]

I believe that the same settings.schema.json is used for two different purposes, with two different requirements.

1. Intellisense in editors, when we are editing the AL-Go settings files in different places
2. Validation of the merged settings, that is used internally in AL-Go. (see Actions.Modules\ReadSettings.psm1)

For 1 (external), we should not have that many required properties. Today this causes a lot of unnecessary warnings.
For 2 (internal), these properties should be required and validated, to make sure that nothing in the AL-Go logic has been missed. This should probably stay as it is today.

IMO, we should not use the same schema file for both purposes.

Maybe the internal schema could extend the external schema with the required settings, using $ref and allOf.

[cegekaJG]

Agreed. Before the schema was added (to the $schema parameter of the config files, at least), I had written custom schemas for the default config files: .AL-Go/settings.json and .github/AL-Go-settings.json. Maybe having everything in a single schema makes the validation in ReadSettings easier, but it doesn't look like there's been much consideration integrating it with Intellisense.