Skip to content

README.md

Latest commit

 

History

History
93 lines (67 loc) · 6.06 KB

README.md

File metadata and controls

93 lines (67 loc) · 6.06 KB

TALXIS.DevKit.Build.Dataverse.Tasks

Core MSBuild tasks and targets library shared by all TALXIS.DevKit.Build.Dataverse.* packages. Provides custom C# MSBuild tasks for Git-based version generation, solution XML patching, solution packaging via PAC CLI, schema validation, CMT data merging, code app metadata generation, and web resource management. Most users do not reference this package directly -- it is pulled in as a dependency of the higher-level packages (Plugin, Solution, Pcf, etc.).

Installation

<PackageReference Include="TALXIS.DevKit.Build.Dataverse.Tasks" Version="0.0.0.1" PrivateAssets="All" />

Typically this package is referenced transitively through one of the component packages.

How It Works

The package ships compiled task assemblies for net472 and net6.0. At build time, the correct assembly is selected based on MSBuildRuntimeType (Core vs Full Framework).

Registered MSBuild tasks

Category Tasks
Versioning GenerateGitVersion, ApplyVersionNumber, ApplyPcfVersionNumber, ApplyPluginVersionNumberInSolution
Solution packaging InvokeSolutionPackager, PatchSolutionXml, EnsureCustomizationsNode, EnsureAllCustomizationsNodes
Component metadata EnsurePluginAssemblyDataXml, EnsureWorkflowActivityAssemblyDataXml, EnsureWebResourceDataXml, AddRootComponentToSolution, GenerateCodeAppMetaXml
Validation ValidateXmlFiles, ValidateJsonFiles, ValidateDuplicateGuids, ValidateQuickFindViews, ValidatePcfDependencies
CMT data MergeCmtDataXml, MergeCmtDataSchemaXml, AppendCmtDataFileToImportConfig, PostProcessImportConfig
Utilities RetrieveProjectReferences, ResolveWebResourceName

Key targets

  • GenerateVersionNumber -- requires the Version property. Runs GenerateGitVersion using the major/minor from Version, the current Git branch, and ApplyToBranches rules to produce a full four-part version number.
  • ApplyVersionNumber -- patches the generated version into solution metadata folders (SolutionXml, PluginAssemblies, Workflows, Controls, SdkMessageProcessingSteps).
  • ApplyPcfVersionNumber -- updates the version in ControlManifest.xml for PCF controls.
  • PackDataverseSolution -- invokes the PAC solution packager to produce a .zip from the working directory.
  • ValidateSolutionComponentSchema -- validates all solution XML files against bundled XSD schemas (22 schemas covering Solution, Entity, Form, Ribbon, Relationship, AppModule, Sitemap, OptionSet, Workflow, PluginAssembly, and more) and JSON files against JSON schemas (Flow.schema.json for Power Automate flows). Runs in batch mode -- collects all errors across all files before failing the build, with MSBuild-canonical error format (file(line,col): error CODE: message) for IDE click-through support.
  • InitializeSolutionPackagerWorkingDirectory -- copies solution source files into the intermediate working directory for packaging.
  • CleanupWorkingDirectory -- removes temporary localization and working directories after build.

Validation

The ValidateXmlFiles and ValidateJsonFiles tasks ship with 22 XSD schemas and 1 JSON schema covering all Dataverse solution component types. Schemas are bundled in the NuGet package under contentFiles/ValidationSchema/.

All XSD schemas share the null target namespace and are loaded into a single XmlSchemaSet, so cross-schema type references (e.g. CrmCascadeSecurityLinkType defined in Customizations.xsd but used in Relationship.xsd) are resolved automatically at compile time.

Error codes emitted by validation tasks:

Code Task Meaning
TALXISXSD001 ValidateXmlFiles XML file violates its XSD schema.
TALXISXML001 ValidateXmlFiles XML file is not well-formed.
TALXISJSON001 ValidateJsonFiles JSON file is not valid JSON.
TALXISJSONSCHEMA001 ValidateJsonFiles JSON file violates its JSON schema.

Tip

Schema validation is not wired into the build pipeline automatically. To run it, invoke the TalxisValidateSolutionComponentSchema target manually, e.g. dotnet build -t:TalxisValidateSolutionComponentSchema.

MSBuild Properties

Versioning

Property Default Description
Version (required) Base version (Major.Minor); used by GenerateGitVersion to produce the full version.
ApplyToBranches (none) Semicolon-separated branch rules (e.g. master;hotfix;develop:1;pr:3;feature/*:2).
LocalBranchBuildVersionNumber 0.0.20000.0 Fallback version used when the current branch does not match ApplyToBranches.

Solution packager paths

Property Default Description
SolutionRootPath . Relative path to the solution source root.
SolutionPackagerWorkingDirectory $(IntermediateOutputPath) Working folder for pack/unpack operations.
SolutionPackagerMetadataWorkingDirectory $(SolutionPackagerWorkingDirectory)Metadata Metadata folder used by version update targets.
SolutionPackagerLocalizationWorkingDirectory (none) Optional localization working folder (cleaned by CleanupWorkingDirectory).
SolutionPackageLogFilePath $(IntermediateOutputPath)SolutionPackager.log SolutionPackager log file path.
SolutionPackageZipFilePath $(OutputPath)$(MSBuildProjectName).zip Output path for the packed solution .zip.

PCF versioning

Property Default Description
PcfOutputPath (none) Output directory containing ControlManifest.xml (used by ApplyPcfVersionNumber).

Related Packages

This is the foundational package in the ecosystem. The following packages depend on it:

  • TALXIS.DevKit.Build.Dataverse.Pcf
  • TALXIS.DevKit.Build.Dataverse.Plugin
  • TALXIS.DevKit.Build.Dataverse.WorkflowActivity
  • TALXIS.DevKit.Build.Dataverse.ScriptLibrary
  • TALXIS.DevKit.Build.Dataverse.CodeApp
  • TALXIS.DevKit.Build.Dataverse.Solution
  • TALXIS.DevKit.Build.Dataverse.PdPackage