Skip to content

Commit 7c332dc

Browse files
committed
Added some love to the readme
1 parent 79f78cb commit 7c332dc

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

README.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,34 @@
33

44
This repository contains a custom .NET CLI tool designed to import configuration data into Microsoft Dataverse environments. It streamlines the migration of configuration data, supports schema validation, and offers extensibility for advanced scenarios.
55

6-
## Features
6+
## Why ❓
7+
8+
Configuration Migration Tool and the PowerPlatform Cli Tool (pac data import verb) seem to have it's limitations when automating in ci/cd. Also, these two only works on a windows machine. \
9+
This new tool enables you to:
10+
11+
- customize/extend the tool to your needs
12+
- use in CD pipeline easily
13+
- runs on windows and **linux**
14+
15+
## ⭐Features⭐
16+
17+
:heavy_check_mark: Import configuration data into Dataverse \
18+
:heavy_check_mark: Schema validation and rule-based checks \
19+
:heavy_check_mark: Support for special characters and self-hierarchy imports \
20+
:heavy_check_mark: Extensible for custom validation and reporting \
21+
:heavy_check_mark: Many to Many Relationships supported \
22+
- :heavy_check_mark: Supports schemas and data files generated from :
23+
- [PowerPlatform CLI Export](https://learn.microsoft.com/en-us/power-platform/developer/cli/reference/data#pac-data-export)
24+
- [Configuration Migration tool](https://learn.microsoft.com/en-us/power-platform/admin/create-schema-export-configuration-data)
25+
26+
❌Field types not supported:
27+
- MultiSelectOptionsets
28+
- Image
29+
- File
30+
- Memo ⚠️ May work haven't tested yet
31+
- Owner ⚠️ Will eventually support it. No user mapping has been done currently
32+
733

8-
- Import configuration data into Dataverse
9-
- Schema validation and rule-based checks
10-
- Support for special characters and self-hierarchy imports
11-
- Extensible for custom validation and reporting
1234

1335
## Getting Started
1436

@@ -17,8 +39,7 @@ This repository contains a custom .NET CLI tool designed to import configuration
1739
- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
1840
- Access to a Microsoft Dataverse environment
1941

20-
### Building the Tool
21-
42+
### 🛠️Building the Tool🛠️
2243
1. Clone the repository:
2344
```powershell
2445
git clone https://github.com/dotnetprog/dataverse-configuration-migration-tool.git
@@ -47,13 +68,13 @@ Run the CLI tool with the required arguments (no need to pass clientId or client
4768
dotnet run --environment DOTNET_ENVIRONMENT=Development --project Dataverse.ConfigurationMigrationTool.Console -- import --data "path/to/data.xml" --schema "path/to/schema.xml"
4869
```
4970

50-
#### Import Command Line Arguments
71+
#### 💻 Import Command Line Arguments 💻
5172

5273
Verb: `import`
5374
- `--data` : Path to the data xml file
5475
- `--schema` : Path to the schema XML file
5576

56-
## Contributing
77+
## 🤝 Contributing 🤝
5778

5879
Contributions are welcome! To get started:
5980

@@ -68,7 +89,7 @@ Contributions are welcome! To get started:
6889
Please review open issues and the todo list below for ideas on what to contribute.
6990

7091

71-
## Continuous Delivery
92+
## 🚀Continuous Delivery🚀
7293

7394
This repository includes example GitHub Actions workflows for building, testing, and deploying the tool:
7495

@@ -78,7 +99,7 @@ This repository includes example GitHub Actions workflows for building, testing,
7899
You can use these workflows as a starting point for your own CI/CD automation. See the workflow files for details on environment variables, secrets, and deployment steps.
79100

80101

81-
### Generating Schema and Data Files
102+
### </> Generating Schema and Data Files </>
82103

83104
To use the `import` command, you need a schema file and a data file. These can be generated from your Dataverse environment using the official Configuration Migration tool. For detailed instructions, refer to the Microsoft documentation:
84105

0 commit comments

Comments
 (0)