GitHub Action that validates all of the Azure Data Factory resources in the Git repository
Перейти к файлу
Fernando de Oliveira 08c34c81d7 fix: adf utils installation 2021-09-24 16:05:55 -03:00
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md committed 2021-09-16 10:29:45 -07:00
Dockerfile fix: adf utils installation 2021-09-24 16:05:55 -03:00
LICENSE LICENSE committed 2021-09-16 10:29:47 -07:00
README.md fix: example usage 2021-09-17 16:53:41 -03:00
SECURITY.md SECURITY.md committed 2021-09-16 10:29:49 -07:00
SUPPORT.md docs: SUPPORT.md updated 2021-09-16 14:40:01 -03:00
action.yml fix: action name 2021-09-16 15:41:28 -03:00
validate.sh fix: adf utils installation 2021-09-24 16:05:55 -03:00

README.md

Azure Data Factory Validate Action

GitHub Action that validates all of the Azure Data Factory resources in your Git repository using the Azure Data Factory utilities package.

When to use

The action is particularly useful on Continuous Integration (CI) workflows, where a step can be added to check if all Data Factory resources (e.g. pipelines, activities, linked services, datasets, etc) in the target Git branch are valid before applying the changes during the Continuous Deployment (CD) phase.

Getting Started

Prerequisites

  1. Ensure your Data Factory is connected with a Git repository. For more info, see Connect to a Git repository and Bicep & ARM Template formats.

  2. Ensure the following package.json file exists in the same directory that contains your Data Factory resources in the Git repository:

    {
      "scripts":{
        "build":"node node_modules/@microsoft/azure-data-factory-utilities/lib/index"
      },
      "dependencies":{
        "@microsoft/azure-data-factory-utilities":"^0.1.5"
      }
    }
    

Example Usage

steps:
  - name: Validate Data Factory resources
    uses: Azure/data-factory-validate-action@v1.0.0
    # with:
    #   path: ./mydir [optional]
    #   id: <data factory resource ID> [optional]

Inputs

  • path (optional): Directory that contains all Data Factory resources. Defaults to ./ directory.

  • id (optional): Data Factory resource ID. Defaults to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.DataFactory/factories/dataFactory.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.