azure-pipelines.yml

trigger:
  branches:
    include: 
      - pages-source
  paths:
    exclude: 
      - README.md
      - LICENSE
      - LICENSE-CODE
      - .gitignore
      - .markdownlint.json
      - docfx.json
      - CNAME
      - toc.yml

# PR always trigger build   
pr:
  autoCancel: true

resources:
  repositories:
    - repository: templates
      type: github
      name: nanoframework/nf-tools
      endpoint: nanoframework

pool:
  vmImage: 'windows-latest'

variables:
  DOTNET_NOLOGO: true
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:

# need this here in order to persist GitHub credentials
- checkout: self
  persistCredentials: true
  fetchDepth: 1

# setup GitHub credentials and prefs
- script: |
    git config --global user.email "nfbot"
    git config --global user.name "nanoframework@outlook.com"

    git config --global core.autocrlf true
  displayName: Setup git identity

# get commit message
- powershell: |

    #####################
    # grab commit message
    if($env:System_PullRequest_PullRequestId -ne $null)
    {
        # PR build
        "Building from PR" | Write-Host

        # get PR message
        $prUrl = "https://api.github.com/repos/$env:Build_Repository_Name/pulls/$env:System_PullRequest_PullRequestNumber"

        $commit = Invoke-RestMethod -Uri $prUrl -ContentType "application/json" -Method GET -Headers @{Authorization = "Bearer $(GitHubToken)"}

        $commitMessage = $commit.body
    }
    else
    {
        # not a PR, get subject and commit message for commit
        "Building from merge" | Write-Host

        $commitMessage = git log --format='%B' -1
    }

    # need to flatten message by removing new lines
    $commitMessage = $commitMessage.Replace("`r`n", " ")

    "Commit message is: '$commitMessage'" | Write-Host

    # set variable to forward to jobs
    echo "##vso[task.setvariable variable=COMMIT_MESSAGE;isOutput=true]$commitMessage"

    ###########################
    # get list of changed files
    if($env:System_PullRequest_PullRequestId -ne $null)
    {
        # get files changed in PR
        $commit = Invoke-RestMethod -Uri "https://api.github.com/repos/$env:Build_Repository_Name/pulls/$env:System_PullRequest_PullRequestNumber/files" -ContentType "application/json" -Method GET -Headers @{Authorization = "Bearer $(GitHubToken)"}

        # filter removed files              
        $files = $commit.where{$_.status -ne 'removed'}

        # get file names only
        $files = $files | % {$_.filename}

        Write-host "Files changed:"
        $files | % { Write-host $_ }
        Write-host ""

        if( 
          (($files.where{$_.Contains('/')}).Count -eq 0) -Or
          (($files.where{$_.StartsWith('x-cross')}).Count -gt 0)
        )
        {
            # files at:
            # - repo root
            # - x-cross folder

            echo "##vso[task.setvariable variable=BUILD_ALL;isOutput=true]true"
            
            Write-host "Building ALL"
        }
        else
        {
            echo "##vso[task.setvariable variable=BUILD_ALL;isOutput=true]false"
            Write-host "Only content files changed, skipping build"
        }
    }
    else
    {
        # this is not a PR, need to build everything
        echo "##vso[task.setvariable variable=BUILD_ALL;isOutput=true]true"
    }

  name: BuildOptions
  displayName: Get commit details

# clone class libs repos
# fetch only the last 100 commits (if available) to be (reasonaly) sure that we have the history up to the last tag
- powershell: |
      git clone https://github.com/nanoframework/CoreLibrary.git --recursive --depth 100 -b main libs/CoreLibrary 

      git clone https://github.com/nanoframework/nanoFramework.Device.Can.git --depth 100 -b main libs/nanoFramework.Device.Can 

      git clone https://github.com/nanoframework/nanoFramework.Device.OneWire.git --depth 100 -b main libs/nanoFramework.Device.OneWire 

      git clone https://github.com/nanoframework/nanoFramework.Networking.Thread.git --depth 100 -b main libs/nanoFramework.Networking.Thread

      git clone https://github.com/nanoframework/nanoFramework.Runtime.Events.git --depth 100 -b main libs/nanoFramework.Runtime.Events 

      git clone https://github.com/nanoframework/nanoFramework.Runtime.Native.git --depth 100 -b main libs/nanoFramework.Runtime.Native 

      git clone https://github.com/nanoframework/nanoFramework.WebServer -b main libs/nanoFramework.WebServer 

      git clone https://github.com/nanoframework/nanoFramework.DependencyInjection -b main libs/nanoFramework.DependencyInjection 

      git clone https://github.com/nanoframework/nanoFramework.Hosting -b main libs/nanoFramework.Hosting 

      git clone https://github.com/nanoframework/System.Device.Dac.git --depth 100 -b main libs/System.Device.Dac

      git clone https://github.com/nanoframework/System.Device.Gpio.git --depth 100 -b main libs/System.Device.Gpio 

      git clone https://github.com/nanoframework/System.Device.I2c.git --depth 100 -b main libs/System.Device.I2c

      git clone https://github.com/nanoframework/System.Device.I2s.git --depth 100 -b main libs/System.Device.I2s

      git clone https://github.com/nanoframework/System.IO.FileSystem.git --depth 100 -b main libs/System.IO.FileSystem

      git clone https://github.com/nanoframework/System.IO.Streams.git --depth 100 -b main libs/System.IO.Streams

      git clone https://github.com/nanoframework/System.Runtime.Serialization.git --depth 100 -b main libs/System.Runtime.Serialization

      git clone https://github.com/nanoframework/System.Device.Pwm.git --depth 100 -b main libs/System.Device.Pwm

      git clone https://github.com/nanoframework/System.Device.Spi.git --depth 100 -b main libs/System.Device.Spi

      git clone https://github.com/nanoframework/Windows.Storage.git --depth 100 -b main libs/Windows.Storage 

      git clone https://github.com/nanoframework/Windows.Storage.Streams.git --depth 100 -b main libs/Windows.Storage.Streams 
      
      git clone https://github.com/nanoframework/System.Device.Adc.git --depth 100 -b main libs/System.Device.Adc 

      git clone https://github.com/nanoframework/System.Device.WiFi.git --depth 100 -b main libs/System.Device.WiFi

      git clone https://github.com/nanoframework/System.Device.UsbClient.git -b main System.Device.UsbClient

      git clone https://github.com/nanoframework/nanoFramework.Benchmark -b main libs/nanoFramework.Benchmark 

      git clone https://github.com/nanoframework/nanoFramework.Graphics -b main libs/nanoFramework.Graphics

      git clone https://github.com/nanoframework/nanoFramework.GiantGecko.Adc -b main nanoFramework.GiantGecko.Adc

      git clone https://github.com/nanoframework/nanoFramework.Hardware.Esp32 -b main libs/nanoFramework.Hardware.Esp32

      git clone https://github.com/nanoframework/nanoFramework.Hardware.Esp32.Rmt -b main libs/nanoFramework.Hardware.Esp32.Rmt

      git clone https://github.com/nanoframework/nanoFramework.Hardware.GiantGecko -b main nanoFramework.Hardware.GiantGecko

      git clone https://github.com/nanoframework/nanoFramework.Json -b main libs/nanoFramework.Json

      git clone https://github.com/nanoframework/nanoFramework.Hardware.Stm32 -b main libs/nanoFramework.Hardware.Stm32

      git clone https://github.com/nanoframework/nanoFramework.ResourceManager -b main libs/nanoFramework.ResourceManager

      git clone https://github.com/nanoframework/nanoFramework.Networking.Sntp -b main libs/nanoFramework.Networking.Sntp 

      git clone https://github.com/nanoframework/System.Collections -b main libs/System.Collections 

      git clone https://github.com/nanoframework/System.Text -b main libs/System.Text 

      git clone https://github.com/nanoframework/System.Net -b main libs/System.Net 

      git clone https://github.com/nanoframework/System.Net.Http -b main libs/System.Net.Http 

      git clone https://github.com/nanoframework/System.Net.WebSockets -b main libs/System.Net.WebSockets 

      git clone https://github.com/nanoframework/nanoFramework.TI.EasyLink -b main libs/nanoFramework.TI.EasyLink

      git clone https://github.com/nanoframework/nanoFramework.Hardware.TI -b main libs/nanoFramework.Hardware.TI

      git clone https://github.com/nanoframework/System.Math -b main libs/System.Math 

      git clone https://github.com/nanoframework/nanoFramework.Logging -b main libs/nanoFramework.Logging

      git clone https://github.com/nanoframework/System.IO.Ports.git --depth 100 -b main libs/System.IO.Ports

      git clone https://github.com/nanoframework/nanoFramework.m2mqtt.git -b main libs/nanoFramework.M2Mqtt

      git clone https://github.com/nanoframework/System.Text.RegularExpressions.git --depth 100 -b main libs/System.Text.RegularExpressions

      git clone https://github.com/nanoframework/nanoFramework.Azure.Devices.git -b main libs/nanoFramework.Azure.Devices
      
      git clone https://github.com/nanoframework/nanoFramework.Aws.IoTCore.Devices.git -b main libs/nanoFramework.Aws.IoTCore.Devices

      git clone https://github.com/nanoframework/nanoFramework.SignalR.Client.git -b main libs/nanoFramework.SignalR.Client      

      git clone https://github.com/nanoframework/System.Net.Sockets.TcpClient.git -b main libs/System.Net.Sockets.TcpClient

      git clone https://github.com/nanoframework/System.Net.Sockets.UdpClient.git -b main libs/System.Net.Sockets.UdpClient

      git clone https://github.com/nanoframework/System.Device.UsbClient.git -b main libs/System.Device.UsbClient

      git clone https://github.com/nanoframework/nanoFramework.GiantGecko.Adc.git -b main libs/nanoFramework.GiantGecko.Adc
      
      git clone https://github.com/nanoframework/nanoFramework.Hardware.GiantGecko.git -b main libs/nanoFramework.Hardware.GiantGecko

      git clone https://github.com/nanoframework/System.IO.Hashing.git -b main libs/System.IO.Hashing

      git clone https://github.com/nanoframework/System.Security.Cryptography.git -b main libs/System.Security.Cryptography

      git clone https://github.com/nanoframework/System.Device.I2c.Slave.git -b main libs/System.Device.I2c.Slave

      git clone https://github.com/nanoframework/nanoFramework.System.Runtime.git -b main libs/nanoFramework.System.Runtime
      
  displayName: Clone repos of class libs
  condition: >-
    or(
      eq(variables['BUILD_ALL'], 'true'),
      contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
      eq(variables['BuildOptions.BUILD_ALL'], 'true')
    )

# clone IoT bindings repo and Samples
- powershell: |
      git clone https://github.com/nanoframework/nanoFramework.IoT.Device.git -b develop nanoFramework.IoT.Device

      git clone https://github.com/nanoframework/Samples.git -b main Samples
  displayName: Clone IoT binding repo and Samples
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Clean all solutions that are not needed to build nor generate documentation
- task: PowerShell@2
  displayName: Delete unnecessary solutions
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    ) 
  inputs:
    targetType: 'inline'
    script: |
      Remove-Item -Force libs\CoreLibrary\nanoFramework.TestFramework\nanoFramework.TestAdapter.sln
      Remove-Item -Force libs\nanoFramework.M2Mqtt\nanoFramework.Mqtt.TestApps.sln

- powershell: choco install docfx-companion-tools -y
  displayName: Install the docfx helpers
  condition: succeeded()

# install docfx
- task: DotNetCoreCLI@2  
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  displayName: Install docfx
  inputs:
    command: custom
    custom: tool
    arguments: install -g docfx

# Create the README in /devices folder with all IoT.Device bindings
# Run the Generator to physically move the files first
- task: DotNetCoreCLI@2
  displayName: 'Generate all the devices README files'
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    command: 'run'
    projects: 'nanoFramework.IoT.Device\src\GenerateDocFxStructure'
    arguments: '-- -d $(System.DefaultWorkingDirectory)\devicesdetails -m $(System.DefaultWorkingDirectory)\devicesimages -s nanoFramework.IoT.Device/devices -v -r https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/develop/devices -i packages,tests,bin,obj'

# build the TOC and adjust the README.md
- powershell: |
    &DocFxTocGenerator -d $(System.DefaultWorkingDirectory)\devicesdetails -si
    # Define the file path
    $filePath = "$(System.DefaultWorkingDirectory)\devicesdetails\README.md"

    # Read the content of the file
    $content = Get-Content -Path $filePath -Raw

    # Perform the replacement using regex to add /README.md to all the device links
    $newContent = $content -replace '\(([a-zA-Z\d\.]+)\)', '($1/README.md)'

    # Write the updated content back to the file
    Set-Content -Path $filePath -Value $newContent
  displayName: 'Building automatically toc.yml for devices'
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Create the README index
# 1. adjust the settings
- powershell: |
    # Define the path to the Configuration.json file
    $jsonFilePath = "$(System.DefaultWorkingDirectory)/Samples/device-listing/Configuration.json"

    # Read the content of the JSON file
    $jsonContent = Get-Content -Path $jsonFilePath | ConvertFrom-Json

    # Update the values
    $jsonContent.AddReadme = $true

    # Convert the updated object back to JSON
    $jsonContent | ConvertTo-Json | Set-Content -Path $jsonFilePath
  displayName: Adjust configuration to build README
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# 2. copy the README to the Sampes/samples folder
- powershell: |
    Copy-Item -Path $(System.DefaultWorkingDirectory)\samplesdetails\README.md -Destination $(System.DefaultWorkingDirectory)\Samples\README.md
    Remove-Item -Force $(System.DefaultWorkingDirectory)\samplesdetails\README.md
  displayName: Copy samples README to samples folder
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# 3. generate dynamically the list
- task: DotNetCoreCLI@2
  displayName: Generate samples README
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    command: custom
    custom: run
    projects: '$(System.DefaultWorkingDirectory)/Samples/device-listing/device-listing.csproj'
    workingDirectory: '$(System.DefaultWorkingDirectory)\Samples\samples'

# 4. copy the README to the Sampes/samples folder
- powershell: |
    Copy-Item -Path $(System.DefaultWorkingDirectory)\Samples\README.md -Destination $(System.DefaultWorkingDirectory)\Samples\samples\README.md
    # adjust all the links to point to the right place so removing /samples/ from the links

    $filePath = "$(System.DefaultWorkingDirectory)\Samples\samples\README.md"

    # Get the original encoding of the file
    $sr = New-Object System.IO.StreamReader($filePath, $true)
    [char[]] $buffer = new-object char[] 3
    $sr.Read($buffer, 0, 3)  
    $originalEncoding = $sr.CurrentEncoding
    $sr.Close()

    # Making it simple as we only want to preserve UTF8 encoding
    if ( $originalEncoding.BodyName -eq "utf-8" ) {
      $fileEncoding = "UTF8" 
    }
    else {
      $fileEncoding = "ASCII" 
    }
    
    # Read the content of the file using the original encoding
    $content = Get-Content -Path $filePath -Raw -Encoding $fileEncoding
    
    # Perform the replacement using regex to add /README.md to all the device links
    $newContent = $content -replace '\(samples/', '\('

    # Write the updated content back to the file
    Set-Content -Path $filePath -Value $newContent -Encoding $fileEncoding
  displayName: Copy samples README to samples folder
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Create the README in /samples folder with all Samples readme
# Run the Generator to physically move the files first
- task: DotNetCoreCLI@2
  displayName: 'Generate all the samples README files'
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    command: 'run'
    projects: 'nanoFramework.IoT.Device\src\GenerateDocFxStructure'
    arguments: '-- -d $(System.DefaultWorkingDirectory)\samplesdetails -m $(System.DefaultWorkingDirectory)\samplesimages -s Samples/samples -v -r https://github.com/nanoframework/Samples/tree/main/samples -i packages,tests,bin,obj'

# 5. Build the TOC
- powershell: |
    &DocFxTocGenerator -d $(System.DefaultWorkingDirectory)\samplesdetails -si
  displayName: 'Building automatically toc.yml for samples'
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Build the TOC for all the content folder
- powershell: |
    &DocFxTocGenerator -d $(System.DefaultWorkingDirectory)\content -s -r -g
  displayName: 'Building automatically toc.yml for main content'
  condition: succeeded()

# Check the links
- powershell: |
    &DocLinkChecker -d $(System.DefaultWorkingDirectory)\content -t
  displayName: 'Check internal links in the core repo'
  condition: succeeded()

# Scan markdown files on style consistency
- powershell: |
    npm install -g markdownlint-cli
    markdownlint -c  $(System.DefaultWorkingDirectory)/.markdownlint.json $(System.DefaultWorkingDirectory)/content
  displayName: 'Execute Markdownlint'
  condition: succeeded()

# we then need to add the root index page to the toc
- powershell: |
    # read all lines into `$fileContents`
    $filePath = "$(System.DefaultWorkingDirectory)\content\toc.yml"
    $fileContents = Get-Content $filePath 

    # append text to desired line
    $textToAdd = "items:
    - name: Home
      href: ../index.md"
    $fileContents[1] = $fileContents[1].Replace("items:", $textToAdd)
    
    # write all lines back to file
    $fileContents | Set-Content $filePath
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  displayName: Adjust TOC to add main index

# install specific version of nuget CLI
- template: azure-pipelines-templates/install-nuget.yml@templates

- task: Cache@2
  displayName: Cache NuGet packages
  condition: >-
    and(
      succeeded(), 
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  continueOnError: true
  inputs:
    key: 'nuget | **/packages.lock.json'
    path: $(UserProfile)/.nuget/packages

# restore all solutions
- task: NuGetCommand@2
  displayName: NuGet restore all class libs
  retryCountOnTaskFailure: 3
  inputs:
    restoreSolution: 'libs/**/*.sln'
    feedsToUse: 'select'

# Build part
- task: InstallNanoMSBuildComponents@1
  displayName: Install nanoFramework MSBuild components
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    GitHubToken: $(GitHubToken)

# this is required for IoT bindings build
- task: DotNetCoreCLI@2  
  displayName: Install nanovc tool
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    command: custom
    custom: tool
    arguments: install -g nanovc --add-source https://pkgs.dev.azure.com/nanoframework/feed/_packaging/sandbox/nuget/v3/index.json
  
# This will build all class libraries in the libs folder
- task: VSBuild@1
  displayName: Build all class libs
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  retryCountOnTaskFailure: 3
  inputs:
    solution: 'libs/**/*.sln'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    msbuildArchitecture: 'x64'
    maximumCpuCount: true

# This should build all the bindings in nanoFramework.IoT.Device in the devices directory
- task: PowerShell@2
  displayName: Build all from nanoFramework.IoT.Device
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    workingDirectory: 'nanoFramework.IoT.Device\devices'
    targetType: 'filePath'
    filePath: 'nanoFramework.IoT.Device\.pipeline-assets\pipeline-build-solutions.PS1'
  env:
    MY_GITHUBTOKEN: $(GitHubToken)
    DEVICE_TO_BUILD: 'ALL'

# Clean what's not needed from IoT.Device and adjust the nugets to remove nerdbank to help build
- task: PowerShell@2
  displayName: Delete generated device folder from IoT.Device and clean references
  condition: >-
    and(
      succeeded(), 
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    targetType: 'inline'
    script: |
      Remove-Item -Recurse -Force nanoFramework.IoT.Device\src\devices_generated
      Remove-Item -Recurse -Force nanoFramework.IoT.Device\src\nanoFramework.IoT.Device.CodeConverter
      Remove-Item -Recurse -Force nanoFramework.IoT.Device\src\GenerateDocFxStructure
      cd nanoFramework.IoT.Device\devices
      $Nerdbank = '<package id="Nerdbank.GitVersioning"'
      $Files = Get-ChildItem -Filter "packages.config" -Recurse
      foreach ($File in $Files) {
        $FullPath = $File | % { $_.FullName }
        $ToReplace = Get-Content $FullPath
        $Replaced = $ToReplace `
        | Where-Object { $_ -notmatch $Nerdbank }
        Set-Content -path $FullPath -Value $Replaced
      }
# Replace the intrument key
- powershell: |
      . ./common.ps1
      $fileToReplace = "$(System.DefaultWorkingDirectory)/templates/material/public/main.js"
      $sourceString = "INTRUMENT_KEY"
      $instrumentKey = "$(InstrumentKey)"

      Find-ReplaceInFile -filePath $fileToReplace -sourceString $sourceString -targetString $instrumentKey
  displayName: Replace intrument key
  condition: >-
    and(
      succeeded(), 
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# run docfx
- powershell: |
      &docfx metadata docfx.json
      
      if ($lastexitcode -ne 0)
      {
        throw [System.Exception] "docfx build failed with exit code $lastexitcode."
      }

      &docfx build docfx.json
      
      if ($lastexitcode -ne 0)
      {
        throw [System.Exception] "docfx build failed with exit code $lastexitcode."
      }
  displayName: Run docfx
  condition: >-
    and(
      succeeded(), 
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Replace the links to improve doc for dynamic content in devicedetails
- powershell: |
      . ./common.ps1
      
      # Set the source and target strings
      $sourceString = "https://github.com/nanoframework/nanoframework.github.io/blob/pages-source/devicesdetails"
      $targetString = "https://github.com/nanoframework/nanoframework.IoT.Device/blob/develop/devices"

      # Set the root directory where you want to perform the search and replace
      $rootDirectory = "_site/devicesdetails"

      if (Check-DirectoryExists -rootDirectory $rootDirectory) {
        Find-ReplaceInFiles -rootDirectory $rootDirectory -sourceString $sourceString -targetString $targetString
      } else {
          Write-HostMessage -message "Directory $rootDirectory does not exist."
      }

  displayName: Replace dynamically links in devicesdetails
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Replace the links to improve doc for dynamic content in samples
- powershell: |
      . ./common.ps1

      # Set the source and target strings
      $sourceString = "https://github.com/nanoframework/nanoframework.github.io/blob/pages-source/samplesdetails"
      $targetString = "https://github.com/nanoframework/Samples/blob/main/samples"

      # Set the root directory where you want to perform the search and replace
      $rootDirectory = "_site/samplesdetails"

      if (Check-DirectoryExists -rootDirectory $rootDirectory) {
        Find-ReplaceInFiles -rootDirectory $rootDirectory -sourceString $sourceString -targetString $targetString
      } else {
          Write-HostMessage -message "Directory $rootDirectory does not exist."
      }

  displayName: Replace dynamically links in samplesdetails
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Patch the transformed samplesdetails/README.html as margdig used by DocFX do not transform the links properly
- powershell: |
      # Definte the file path to adjust
      $filePath = "$(System.DefaultWorkingDirectory)/_site/samplesdetails/README.html"

      # Making it simple as we only want to preserve UTF8 encoding
      $fileEncoding = "UTF8"

      # Read the content of the file using the original encoding
      $content = Get-Content -Path $filePath -Raw -Encoding $fileEncoding

      # Perform the replacement using regex to replace the MArkdown links by HTML links
      $newContent = $content -replace '\[(.*)\]\((.*)\.md\)', '<a href="$2.html">$1</a>'

      # Write the updated content back to the file
      Set-Content -Path $filePath -Value $newContent -Encoding $fileEncoding
  displayName: Fixing the samplesdetails/README.html links
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )

# Make an artifact for debug purpose
- task: ArchiveFiles@2
  displayName: Zipping _site directory
  condition: >-
    and(
      succeeded(),
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    rootFolderOrFile: '$(Build.SourcesDirectory)\_site' 
    includeRootFolder: true
    archiveType: 'zip'
    archiveFile: '$(Build.ArtifactStagingDirectory)/site.zip' 
    replaceExistingArchive: true 

- task: PublishBuildArtifacts@1
  displayName: Publish deployable artifacts
  condition: >-
    and(
      succeeded(), 
      or(
        eq(variables['BUILD_ALL'], 'true'),
        contains(variables['BuildOptions.COMMIT_MESSAGE'], '***BUILD_ALL***'),
        eq(variables['BuildOptions.BUILD_ALL'], 'true')
      )
    )
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)'
    ArtifactName: site
    ArtifactType: Container

# commit changes (only if this is NOT a PR build)
- powershell: |
    git clone https://github.com/nanoframework/nanoframework.github.io.git -b master origin_site -q
    Copy-Item _site/* origin_site -recurse -Force
    
    cd origin_site > $null

    $auth = "basic $([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("nfbot:$(GitHubToken)")))"

    git add . -A > $null
    git commit -m "Update documentation from PR" -q > $null
    git -c http.extraheader="AUTHORIZATION: $auth" push origin master -q > $null
  failOnStderr: false
  ignoreLASTEXITCODE: true
  condition: >-
    and(
      succeeded(),
      eq(variables['System.PullRequest.PullRequestId'], '')
    )
  displayName: Commit changes in website

# step from template @ nf-tools repo
# report error
- template: azure-pipelines-templates/discord-webhook-task.yml@templates  
  parameters:
    status: 'failure'
    webhookUrl: '$(DiscordWebhook)'
    message: ''