How to

Table Documentation Generator

Overview

This task automates the documentation of Dataverse entities. It reads files from an unpacked solution and generates Markdown documentation for each table and its attributes.

Key Features

Automated Documentation: Generates Markdown documentation from Dataverse entity files.
Entity and Attribute Details: Documents each entity’s attributes, including names, types, display names, and required levels.
Flexible Output: Choose to generate documentation in a single file or separate files for each entity.
Version Control Ready: The generated Markdown files can be integrated into your version control system.

How to Use

Add the task to your Azure DevOps pipeline.
Configure the inputs:
- locationOfUnpackedSolution: Path to the folder with the unpacked Dataverse solution.
- wikiLocation: Path where the generated Markdown files will be stored.
- useSingleFile: Choose true for a single file or false for separate files.
Run the pipeline to generate the documentation.

Example Pipeline Usage

- task: documentSolutionTables@1
  inputs:
    locationOfUnpackedSolution: "$(Build.ArtifactStagingDirectory)/UnpackedSolution"
    wikiLocation: "$(Build.ArtifactStagingDirectory)/WikiDocs"
    useSingleFile: true

Table Relationship Documentation Generator

Overview

This task documents relationships between Dataverse tables by parsing relationship data from XML files and generating Markdown documentation.

Key Features

Automated Relationship Documentation: Generates Markdown documentation for table relationships.
Relationship Details: Documents relationship types and cascades.
Mermaid Diagrams: Generates diagrams using Mermaid syntax to visualize relationships.
Flexible Output: Choose to generate a single file or separate files for each table.
Version Control Ready: The documentation can be integrated into your version control system.

How to Use

Add the task to your Azure DevOps pipeline.
Configure the inputs:
- locationOfUnpackedSolution: Path to the folder with the unpacked Dataverse solution.
- wikiLocation: Path where the generated Markdown files will be stored.
- useSingleFile: Choose true for a single file or false for separate files.
Run the pipeline to generate the documentation.

Example Pipeline Usage

- task: documentTableRelationships@1
  inputs:
    locationOfUnpackedSolution: "$(Build.ArtifactStagingDirectory)/UnpackedSolution"
    wikiLocation: "$(Build.ArtifactStagingDirectory)/WikiDocs"
    useSingleFile: true

Solution XML Node Attribute Updater

Overview

This task updates specific attributes in XML solution files using PowerShell, allowing dynamic adjustments without manual editing.

Key Features

Automated XML Updates: Updates attributes within XML files during pipeline execution.
XPath Node Selection: Uses XPath expressions to select specific XML nodes.
Flexible Configuration: Input the file path, node XPath, attribute name, and new value.
Improves Automation: Ideal for automating configuration changes or version updates.

How to Use

Add the task to your Azure DevOps pipeline.
Configure the inputs:
- XmlFilePath: Path to the XML file to modify.
- NodeXPath: XPath expression to locate the XML node.
- attributeName: Name of the attribute to modify.
- NewValue: New value for the attribute.
Run the pipeline to update the XML file.

Example Pipeline Usage

- task: solutionXMLNodeAttributeUpdater@1
  inputs:
    xmlFilePath: "$(Build.SourcesDirectory)/Solutions/MySolution/Entity.xml"
    nodeXPath: "/Entity/Attributes/Attribute[@Name='DisplayName']"
    attributeName: "DisplayName"
    newValue: "NewDisplayName"

Solution XML Node Updater

Overview

This task updates specific XML nodes within Power Platform solution files, allowing dynamic adjustments during pipeline runs.

Key Features

Automated Node Updates: Updates values of specific XML nodes during pipeline execution.
Precise Node Selection: Uses XPath expressions to locate and modify nodes.
Flexible and Dynamic: Allows dynamic updates to XML nodes.
Streamlined Automation: Ideal for build and release pipelines.

How to Use

Add the task to your Azure DevOps pipeline.
Configure the inputs:
- XmlFilePath: Path to the XML file with the node to update.
- NodeXPath: XPath expression to locate the XML node.
- NewValue: New value for the node.
Run the pipeline to update the XML node.

Example Pipeline Usage

- task: solutionXMLNodeUpdater@1
  inputs:
    xmlFilePath: "$(Build.SourcesDirectory)/Solutions/MySolution/Entity.xml"
    nodeXPath: "/Entity/Attributes/Attribute[@Name='Description']"
    newValue: "Updated description"

Dataverse 4 Teams Export

Overview

This task exports and unpacks solutions from a Dataverse for Teams environment, automating the process and allowing easy management and versioning of Power Platform assets.

Key Features

Solution Export: Automates the export of a solution from Dataverse for Teams.
Canvas App Unpacking: Unpacks .msapp files for version control and customization.
Solution Settings Template: Generates a settings template file.
PAC CLI Integration: Uses the Power Platform CLI for authentication and solution operations.

How to Use

Add the task to your Azure DevOps pipeline.
Configure the inputs:
- solutionName: Name of the solution to export.
- exportDirectory: Directory to save the exported solution.
- unpackDirectory: Directory to unpack the solution.
- environment: URL of the Dataverse for Teams environment.
Ensure PAC CLI is installed in your pipeline environment.
Run the pipeline to export and unpack the solution.

Example Pipeline Usage

- task: dataverse4TeamsExport@1
  inputs:
    solutionName: "MySolution"
    exportDirectory: "$(Build.ArtifactStagingDirectory)/ExportedSolutions"
    unpackDirectory: "$(Build.ArtifactStagingDirectory)/UnpackedSolutions"
    environment: "https://your-environment-url"

Commit To Git Repository

Overview

This task automates committing changes made during a pipeline run to your Git repository, ensuring everything is pushed automatically.

Key Features

Automated Git Commits: Stages and commits all modifications to the Git repository.
Secure Authentication: Uses the pipeline’s System.AccessToken for authentication.
Customizable Commit Message: Specify a commit message via the task’s input parameters.
Flexible Configuration: Set up Git configurations like user email and name.

How to Use

Add the task to your Azure DevOps pipeline.
Specify the commit message using the commitMsg input.
Ensure your pipeline has the System.AccessToken variable enabled.
Run the pipeline to commit and push changes to the repository.

Example Pipeline Usage

- task: commitToRepo@1
  inputs:
    commitMsg: "Automated commit from pipeline"

Setup