Table of Contents

Azure DevOps CI/CD examples

These are basic pipeline examples for uploading to the Catalog and/or deploying to DMAs connected to dataminer.services.

We recommend combining these with quality control beforehand, such as executing static code analysis and running tests.

Tip

For information on creating a new pipeline in Azure DevOps, see Azure Tutorial.

Basic upload of non-connector items

This is a basic pipeline for uploading non-connector items to the Catalog. Eventually, you will also be able to deploy such items to DMAs connected to dataminer.services using this pipeline, but this is not yet supported at the moment.

To upload an item to the Catalog, you will need DATAMINER_TOKEN as a secret. This will be the key for the DataMiner organization as provided through the Admin app.

On a Ubuntu runner:

trigger:
  branches:
    include:
      - master
      - main

variables:
  DATAMINER_TOKEN: $(DATAMINER_TOKEN)  # Secret from Azure DevOps Library or Pipeline variables

jobs:
 - job: UbuntuBuildAndUpload
    displayName: 'Ubuntu: Build and Register to Catalog'
    pool:
      vmImage: 'ubuntu-latest'
    steps:
      - checkout: self

      - script: |
          dotnet publish \
            -p:Version="0.0.$(Build.BuildId)-prerelease" \
            -p:VersionComment="This is just a pre-release version." \
            -p:CatalogPublishKeyName="DATAMINER_TOKEN" \
            -p:CatalogDefaultDownloadKeyName="DATAMINER_TOKEN"
        displayName: 'Publish and Register to Catalog'
        env:
          DATAMINER_TOKEN: $(DATAMINER_TOKEN)

On a Windows runner:

trigger:
  branches:
    include:
      - master
      - main

variables:
  DATAMINER_TOKEN: $(DATAMINER_TOKEN)  # Secret from Azure DevOps Library or Pipeline variables

jobs:
  - job: WindowsBuildAndUpload
    displayName: 'Windows: Build and Register to Catalog'
    pool:
      vmImage: 'windows-latest'
    steps:
      - checkout: self

      - script: |
          dotnet publish `
            -p:Version="0.0.$(Build.BuildId)-prerelease" `
            -p:VersionComment="This is just a pre-release version." `
            -p:CatalogPublishKeyName="DATAMINER_TOKEN" `
            -p:CatalogDefaultDownloadKeyName="DATAMINER_TOKEN"
        displayName: 'Publish and Register to Catalog'
        env:
          DATAMINER_TOKEN: $(DATAMINER_TOKEN)

Azure DevOps pipeline for connectors

For this pipeline, you will need a dataminer.services key for the specific DMS to which you want to deploy the connectors. For more information on how to create a dataminer.services key, refer to Managing dataminer.services keys.

As you can see below, you will need a secret variable DATAMINER_DEPLOY_KEY that contains this dataminer.services key and an uploadOutput variable that is allowed to change during the run.

trigger:
- master

pool:
  vmImage: ubuntu-latest

steps:
- checkout: self

- script: dotnet tool install -g Skyline.DataMiner.CICD.Tools.Packager
  displayName: 'Install Packager'

- script: dotnet tool install -g Skyline.DataMiner.CICD.Tools.CatalogUpload
  displayName: 'Install Catalog Upload'

- script: dotnet tool install -g Skyline.DataMiner.CICD.Tools.DataMinerDeploy
  displayName: 'Install Catalog Deploy'

- script: dataminer-package-create dmprotocol $(Build.SourcesDirectory) --name HelloFromAzure --output $(Build.SourcesDirectory)
  displayName: 'Create Package'

- script: |
    uploadOutput=$(dataminer-catalog-upload --path-to-artifact "$(Build.SourcesDirectory)/HelloFromAzure.dmprotocol" --dm-catalog-token $(DATAMINER_DEPLOY_KEY))
    echo "##vso[task.setvariable variable=uploadOutput]$uploadOutput"
  displayName: 'Upload Package'

- script: dataminer-package-deploy from-volatile --artifact-id "$(uploadOutput)" --dm-system-token $(DATAMINER_DEPLOY_KEY)
  displayName: 'Deploy Package'
Improve this page