Skip to content

Commit

Permalink
docs: add docs for synapse support
Browse files Browse the repository at this point in the history
  • Loading branch information
jayachithra committed Aug 30, 2024
1 parent 79f5fbc commit 20a28c1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Factory - Testing Framework :hammer_and_wrench:

A stand-alone test framework that allows to write unit tests for Data Factory pipelines on [Microsoft Fabric](https://learn.microsoft.com/en-us/fabric/data-factory/) and [Azure Data Factory](https://learn.microsoft.com/en-us/azure/data-factory/concepts-pipelines-activities?tabs=data-factory).
A stand-alone test framework that allows to write unit tests for Data Factory pipelines on [Microsoft Fabric](https://learn.microsoft.com/en-us/fabric/data-factory/), [Azure Data Factory](https://learn.microsoft.com/en-us/azure/data-factory/concepts-pipelines-activities?tabs=data-factory) and [Azure Synapse Analytics](https://learn.microsoft.com/en-us/azure/data-factory/concepts-pipelines-activities?tabs=data-factory).

> The framework is currently in _Public Preview_ and is not officially supported by Microsoft.
Expand Down Expand Up @@ -84,6 +84,10 @@ Azure Data Factory:
1. [Copy blobs example](examples/data_factory/copy_blobs/README.md)
2. [Batch job example](examples/data_factory/batch_job/README.md)

Azure Synapse Analytics:

1. [Copy blobs example](examples/synapse/copy_blobs/README.md)

## Contributing :handshake:

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/development_workflow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Recommended development workflow for Azure Data Factory v2
# Recommended development workflow for Azure Data Factory (ADF) v2 and Azure Synapse Analytics

* Use ADF Git integration
* Use ADF / Azure Synapse Analytics Git integration
* Use UI to create a feature branch, build the initial pipeline, and save it to the feature branch
* Pull feature branch locally
* Start writing unit and functional tests, run them locally for immediate feedback, and fix bugs
Expand Down
5 changes: 3 additions & 2 deletions docs/basic/repository_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ To be able to write tests for data factory, the pipeline and activity definition

1. [Fabric - Git integration process](https://learn.microsoft.com/fabric/cicd/git-integration/git-integration-process)
2. [Azure Data Factory - Git integration process](https://learn.microsoft.com/azure/data-factory/source-control)
3. [Azure Synapse Analytics - Git integration process](https://learn.microsoft.com/en-us/azure/synapse-analytics/cicd/source-control)

### Alternative for Azure Data Factory
### Alternative for Azure Data Factory and Azure Synapse Analytics

To download a single JSON file for testing purposes, follow these steps:

1. Open the Data Factory instance, and open the pipeline to be tested.
1. Open the Data Factory or Synapse Analytics instance, and open the pipeline to be tested.
2. Click on the action ellipses
3. Click "Download support files"
4. Extract the zip file containing the pipeline definition in a folder of choice.
Expand Down

0 comments on commit 20a28c1

Please sign in to comment.