📝 (index.md): update documentation links and correct preview URL #651
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build & Release (Azure DevOps Migration Tools) | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| on: | |
| push: | |
| branches: ["main"] | |
| tags-ignore: ["v*-*"] | |
| pull_request: | |
| branches: ["main"] | |
| workflow_dispatch: | |
| inputs: | |
| ForceRelease: | |
| description: 'Force a release! Use when changes hapen out of sync and `src` and `docs` folder changes are not detected.' | |
| required: false | |
| default: false | |
| type: boolean | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event.pull_request.head.repo.fork }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: pwsh | |
| jobs: | |
| # Setup & Configuration | |
| Setup: | |
| name: "Setup & Configuration " | |
| runs-on: ubuntu-latest | |
| outputs: | |
| GitVersion_BranchName: ${{ steps.gitversion.outputs.GitVersion_BranchName }} | |
| GitVersion_SemVer: ${{ steps.gitversion.outputs.GitVersion_SemVer }} | |
| GitVersion_PreReleaseLabel: ${{ steps.gitversion.outputs.GitVersion_PreReleaseLabel }} | |
| GitVersion_AssemblySemVer: ${{ steps.gitversion.outputs.GitVersion_AssemblySemVer }} | |
| GitVersion_InformationalVersion: ${{ steps.gitversion.outputs.GitVersion_InformationalVersion }} | |
| GitVersion_NuGetVersion: ${{ steps.gitversion.outputs.GitVersion_NuGetVersion }} | |
| GitVersion_PreReleaseNumber: ${{ steps.gitversion.outputs.GitVersion_PreReleaseNumber }} | |
| GitVersion_MajorMinorPatch: ${{ steps.gitversion.outputs.GitVersion_MajorMinorPatch }} | |
| HasChanged_src: ${{ steps.filter.outputs.src }} | |
| HasChanged_docs: ${{ steps.filter.outputs.docs }} | |
| HasChanged_automation: ${{ steps.filter.outputs.automation }} | |
| nkdAgility_Ring: ${{ steps.nkdagility.outputs.Ring }} | |
| nkdAgility_WingetApplicationId: ${{ steps.nkdagility.outputs.WingetApplicationId }} | |
| nkdAgility_ReleaseDescription: ${{ steps.nkdagility.outputs.release_description }} | |
| nkdAgility_ReleaseDescriptionState: ${{ steps.nkdagility.outputs.release_description_state }} | |
| nkdAgility_DocsDeployFolder: ${{ steps.nkdagility.outputs.docs_deploy_folder }} | |
| nkdAgility_DocsBaseURL: ${{ steps.nkdagility.outputs.docs_baseURL }} | |
| nkdAgility_DocsBaseURL_AFD: ${{ steps.nkdagility.outputs.docs_baseURL_AFD }} | |
| nkdAgility_DocsVersionFolder: ${{ steps.nkdagility.outputs.docs_version_folder }} | |
| nkdAgility_RunRelease: ${{ steps.nkdagility.outputs.RunRelease }} | |
| nkdAgility_AzureSitesEnvironment: ${{ steps.nkdagility.outputs.AzureSitesEnvironment }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: "Fix contibutions if main" | |
| shell: pwsh | |
| if: ${{ (github.event.pull_request.head.repo.fork && github.ref == 'refs/heads/main') }} | |
| id: contributionbranchfix | |
| run: | | |
| # Get environment variables | |
| $branchName = "pr-temp-${{ github.event.pull_request.number }}" | |
| $newBranchName = "contrib/$branchName" | |
| git checkout -b $newBranchName | |
| - name: Install GitVersion | |
| uses: gittools/actions/gitversion/[email protected] | |
| with: | |
| versionSpec: '5.x' | |
| includePrerelease: true | |
| - name: Execute GitVersion | |
| id: gitversion | |
| uses: gittools/actions/gitversion/[email protected] | |
| with: | |
| useConfigFile: true | |
| - uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| src: | |
| - 'src/**' | |
| - '!src/MigrationTools.Telemetery/**' | |
| docs: | |
| - 'docs/**' | |
| automation: | |
| - 'build/**' | |
| - '.github/workflows/**' | |
| - name: "Build NKDAgility Outputs" | |
| shell: pwsh | |
| id: nkdagility | |
| run: | | |
| # Get Branch Name | |
| Write-Output "::group::Get Branch Name" | |
| Write-Output "-------------------------------------------" | |
| $branchName = "${{ github.head_ref || github.ref_name }}" | |
| Write-Output "We are running on: $branchName!" | |
| $branchSafeName = $branchName.Replace("/", "-") | |
| Write-Output "branchSafeName: $branchSafeName!" | |
| Write-Output "-------------------------------------------" | |
| Write-Output "::endgroup::" | |
| # Ring Setup | |
| Write-Output "::group::Ring Control Setup" | |
| Write-Output "-------------------------------------------" | |
| Write-Output "Ring Control Setup" | |
| Write-Output "-------------------------------------------" | |
| $Ring = "Canary" | |
| $WingetApplicationId = "nkdagility.azure-devops-migration-tools" | |
| $docs_deploy_folder = "./azure-devops-migration-tools/"; | |
| $docs_baseURL = "/learn/azure-devops-migration-tools" | |
| $docs_baseURL_AFD = "/learn/azure-devops-migration-tools" | |
| $RunCodeRelease = 'false' | |
| $RunDocsRelease = 'false' | |
| switch ($Env:GitVersion_PreReleaseLabel) { | |
| "" { | |
| $Ring = "Release"; | |
| $WingetApplicationId = "nkdagility.azure-devops-migration-tools"; | |
| $docs_deploy_folder = "./azure-devops-migration-tools/" | |
| $docs_baseURL = "/learn/azure-devops-migration-tools" | |
| $docs_baseURL_AFD = "/learn/azure-devops-migration-tools" | |
| $AzureSitesEnvironment = "" | |
| $RunRelease = 'true' | |
| } | |
| "Preview" { | |
| $Ring = "Preview"; | |
| $WingetApplicationId = "nkdagility.azure-devops-migration-tools.Preview"; | |
| $docs_deploy_folder = "./azure-devops-migration-tools/preview/"; | |
| $docs_baseURL = "/learn/azure-devops-migration-tools/preview" | |
| $docs_baseURL_AFD = "" | |
| $AzureSitesEnvironment = "preview"; | |
| $RunRelease = ( ('${{ inputs.ForceRelease }}' -eq 'true' ) -or ('${{ steps.filter.outputs.src }}' -eq 'true') -or ('${{ steps.filter.outputs.docs }}' -eq 'true') ) | |
| } | |
| default { | |
| $Ring = "Canary"; | |
| $WingetApplicationId = "nkdagility.azure-devops-migration-tools.Canary"; | |
| $docs_deploy_folder = "./azure-devops-migration-tools/canary/$branchSafeName" | |
| $docs_baseURL = "/learn/azure-devops-migration-tools/canary/$branchSafeName" | |
| $docs_baseURL_AFD = "" | |
| $AzureSitesEnvironment = "canary-${{ github.event.pull_request.number }}" | |
| $RunRelease = 'false' | |
| } | |
| } | |
| Write-Output "We are running for the $Ring Ring!" | |
| echo "Ring=$Ring" >> $env:GITHUB_OUTPUT | |
| Write-Output "We are focused on Winget ID $WingetApplicationId!" | |
| echo "WingetApplicationId=$WingetApplicationId" >> $env:GITHUB_OUTPUT | |
| Write-Output "docs_deploy_folder=$docs_deploy_folder" | |
| echo "docs_deploy_folder=$docs_deploy_folder" >> $env:GITHUB_OUTPUT | |
| Write-Output "docs_baseURL=$docs_baseURL" | |
| echo "docs_baseURL=$docs_baseURL" >> $env:GITHUB_OUTPUT | |
| Write-Output "docs_baseURL_AFD=$docs_baseURL_AFD" | |
| echo "docs_baseURL_AFD=$docs_baseURL_AFD" >> $env:GITHUB_OUTPUT | |
| Write-Output "We are running for the $AzureSitesEnvironment AzureSitesEnvironment!" | |
| echo "AzureSitesEnvironment=$AzureSitesEnvironment" >> $env:GITHUB_OUTPUT | |
| Write-Output "RunRelease=$RunRelease" | |
| echo "RunRelease=$RunRelease" >> $env:GITHUB_OUTPUT | |
| Write-Output "-------------------------------------------" | |
| Write-Output "::endgroup::" | |
| # Docs Setup | |
| Write-Output "::group::Docs Setup" | |
| Write-Output "-------------------------------------------" | |
| Write-Output "Docs" | |
| Write-Output "-------------------------------------------" | |
| $docs_version_folder = "/azure-devops-migration-tools/$Env:GitVersion_SemVer" | |
| Write-Output "docs_version_folder=$docs_version_folder" | |
| echo "docs_version_folder=$docs_version_folder" >> $env:GITHUB_OUTPUT | |
| Write-Output "-------------------------------------------" | |
| Write-Output "::endgroup::" | |
| # Get-ReleaseDescription | |
| Write-Output "::group::Release Description Setup" | |
| Write-Output "-------------------------------------------" | |
| Write-Output "Get-ReleaseDescription" | |
| Write-Output "-------------------------------------------" | |
| if ($env:GITHUB_EVENT_NAME -ne "pull_request" -and $eventName -ne "pull_request_target") | |
| { | |
| Write-Output "Running Get-ReleaseDescription.ps1" | |
| . .\build\include\Get-ReleaseDescription.ps1 | |
| $description = Get-ReleaseDescription -mode log -OPEN_AI_KEY ${{ secrets.OPENAI_API_KEY }} | |
| if ($description -eq $null) { | |
| $description = "No release description found"; | |
| echo "release_description_state=false" >> $env:GITHUB_OUTPUT | |
| } else { | |
| echo "release_description_state=true" >> $env:GITHUB_OUTPUT | |
| } | |
| $EOF = -join (1..15 | ForEach {[char]((48..57)+(65..90)+(97..122) | Get-Random)}) | |
| echo "release_description<<$EOF" >> $env:GITHUB_OUTPUT | |
| echo $description >> $env:GITHUB_OUTPUT | |
| echo "$EOF" >> $env:GITHUB_OUTPUT | |
| } else { | |
| $description = "Skipping for PR!" | |
| echo "release_description=$description" >> $env:GITHUB_OUTPUT | |
| Write-Output $description | |
| } | |
| Write-Output "-------------------------------------------" | |
| Write-Output "::endgroup::" | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Scripts | |
| path: ./build/** | |
| # Setup Validator | |
| SetupSummeryStage: | |
| name: "Build Run Data" | |
| runs-on: ubuntu-latest | |
| needs: Setup | |
| steps: | |
| - name: "Show Summery" | |
| if: always() | |
| shell: pwsh | |
| id: nkdagility-summery | |
| run: | | |
| $markdown = @" | |
| ## ${{needs.Setup.outputs.GitVersion_SemVer}} (${{needs.Setup.outputs.nkdAgility_Ring}}) | |
| ### NKDAgility | |
| - nkdAgility_Ring: ${{needs.Setup.outputs.nkdAgility_Ring}} | |
| - nkdAgility_WingetApplicationId: ${{needs.Setup.outputs.nkdAgility_WingetApplicationId}} | |
| - nkdAgility_DocsVersionFolder: ${{needs.Setup.outputs.nkdAgility_DocsVersionFolder}} | |
| - nkdAgility_DocsDeployFolder: ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} | |
| - nkdAgility_DocsBaseURL: ${{needs.Setup.outputs.nkdAgility_DocsBaseURL}} | |
| - nkdAgility_AzureSitesEnvironment: ${{needs.Setup.outputs.nkdAgility_AzureSitesEnvironment}} | |
| - nkdAgility_ReleaseDescriptionState: ${{needs.Setup.outputs.nkdAgility_ReleaseDescriptionState}} | |
| - nkdAgility_RunRelease: ${{needs.Setup.outputs.nkdAgility_RunRelease}} | |
| ### GitVersion | |
| - GitVersion_BranchName: ${{needs.Setup.outputs.GitVersion_BranchName}} | |
| - GitVersion_SemVer: ${{needs.Setup.outputs.GitVersion_SemVer}} | |
| - GitVersion_PreReleaseLabel: ${{needs.Setup.outputs.GitVersion_PreReleaseLabel}} | |
| - GitVersion_AssemblySemVer: ${{needs.Setup.outputs.GitVersion_AssemblySemVer}} | |
| - GitVersion_InformationalVersion: ${{needs.Setup.outputs.GitVersion_InformationalVersion}} | |
| - GitVersion_NuGetVersion: ${{needs.Setup.outputs.GitVersion_NuGetVersion}} | |
| ### Has Changed | |
| - HasChanged_src: ${{needs.Setup.outputs.HasChanged_src}} | |
| - HasChanged_docs: ${{needs.Setup.outputs.HasChanged_docs}} | |
| - HasChanged_automation: ${{needs.Setup.outputs.HasChanged_automation}} | |
| "@ | |
| echo $markdown >> $Env:GITHUB_STEP_SUMMARY | |
| - name: "Show Release Description" | |
| if: always() | |
| shell: pwsh | |
| id: nkdAgility_ReleaseDescription | |
| run: | | |
| Write-Host "::debug::nkdAgility_ReleaseDescription | $Env:GITHUB_STEP_SUMMARY" | |
| $markdown = @" | |
| ## nkdAgility_ReleaseDescription | |
| ${{needs.Setup.outputs.nkdAgility_ReleaseDescription}} | |
| "@ | |
| echo $markdown >> $Env:GITHUB_STEP_SUMMARY | |
| # Build, Test, Sonar Cloud Analysis, & Package | |
| build: | |
| name: "Build, Test, Sonar Cloud Analysis, & Package" | |
| runs-on: windows-latest | |
| needs: Setup | |
| if: ${{ success() }} | |
| env: | |
| solution: '**/*.sln' | |
| buildPlatform: 'Any CPU' | |
| buildConfiguration: 'Release' | |
| nkdAgility_Ring: ${{ needs.Setup.outputs.nkdAgility_Ring }} | |
| GitVersion_SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| GitVersion_AssemblySemVer: ${{ needs.Setup.outputs.GitVersion_AssemblySemVer }} | |
| GitVersion_InformationalVersion: ${{ needs.Setup.outputs.GitVersion_InformationalVersion }} | |
| GitVersion_NuGetVersion: ${{ needs.Setup.outputs.GitVersion_NuGetVersion }} | |
| GitVersion_PreReleaseLabel: ${{ needs.Setup.outputs.GitVersion_PreReleaseLabel }} | |
| GitVersion_PreReleaseNumber: ${{ needs.Setup.outputs.GitVersion_PreReleaseNumber }} | |
| GitVersion_MajorMinorPatch: ${{ needs.Setup.outputs.GitVersion_MajorMinorPatch }} | |
| steps: | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v4 | |
| if: ${{ !(github.event.pull_request.head.repo.fork) }} | |
| with: | |
| java-version: 17 | |
| distribution: 'zulu' | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: cschleiden/replace-tokens@v1 | |
| with: | |
| files: '["**/StaticVariables.cs"]' | |
| tokenPrefix: "${" | |
| tokenSuffix: "}" | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: | | |
| 8.x | |
| - name: "Find solution files" | |
| shell: pwsh | |
| run: | | |
| Get-Item -Path .\ | |
| Get-ChildItem -Path .\ -Recurse -Filter '*.sln' | ForEach-Object { $_.FullName } | |
| - name: sonar install | |
| if: ${{ !(github.event.pull_request.head.repo.fork) }} | |
| run: dotnet tool install --global dotnet-sonarscanner | |
| - name: sonar begin | |
| if: ${{ !(github.event.pull_request.head.repo.fork) }} | |
| run: dotnet sonarscanner begin | |
| /o:"nkdagility" | |
| /k:"vsts-sync-migrator:master" | |
| /d:sonar.host.url="https://sonarcloud.io" | |
| /d:sonar.token="${{ secrets.SONAR_TOKEN }}" | |
| - run: dotnet build MigrationTools.sln /p:Version=${{ env.GitVersion_SemVer }} /p:FileVersion=${{ env.GitVersion_AssemblySemVer }} /p:InformationalVersion=${{ env.GitVersion_InformationalVersion }} /p:GitVersionTag=${{ env.GitVersion_PreReleaseLabel }} | |
| name: Build MigrationTools.sln | |
| id: Build | |
| - name: "Check that required files exist!" | |
| shell: pwsh | |
| run: | | |
| $foundFiles = Get-ChildItem -Path .\ -Recurse -Filter '*WITDataStore64*' | ForEach-Object { $_.FullName } | |
| if ($foundFiles -eq $null) { | |
| Write-Output "No WITDataStore64 found" | |
| exit 1 | |
| } else { | |
| Write-Output "Found WITDataStore64" | |
| } | |
| $foundFiles | |
| - run: dotnet test "MigrationTools.sln" --results-directory ".\test-results\" --logger trx --collect "Code coverage" --no-build --filter "(TestCategory=L0|TestCategory=L1)" | |
| - run: dotnet test "MigrationTools.sln" --results-directory ".\test-results\" --logger trx --collect "Code coverage" --no-build --filter "(TestCategory=L2|TestCategory=L3)" | |
| - run: dotnet test "MigrationTools.sln" --results-directory ".\test-results\" --logger trx --collect "Code coverage" --no-build --filter "(TestCategory!=L0&TestCategory!=L1&TestCategory!=L2&TestCategory!=L3)" | |
| - name: sonar end | |
| if: ${{ !(github.event.pull_request.head.repo.fork) }} | |
| run: dotnet sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}" | |
| - name: "Package Executable Files" | |
| id: packageExecutable | |
| shell: pwsh | |
| if: ${{ steps.Build.outcome == 'success' }} | |
| run: | | |
| ./build/packageExecutable.ps1 -version ${{ env.GitVersion_SemVer }} -outfolder "./staging" | |
| - name: "Package Chocolatey Files" | |
| shell: pwsh | |
| if: ${{ steps.packageExecutable.outcome == 'success' }} | |
| run: | | |
| $item = Get-ChildItem -Path ./staging/ -Recurse -Filter 'MigrationTools-${{ env.GitVersion_SemVer }}.zip' | Select-Object -First 1 | |
| Write-Output "Found: $item.FullName" | |
| .\build\packageChocolatey.ps1 -SemVer ${{ env.GitVersion_SemVer }} -NuGetVersion ${{ env.GitVersion_NuGetVersion }} -outfolder "./staging" -migrationToolsFilename $item.FullName | |
| - name: "Package Extension Files" | |
| shell: pwsh | |
| if: ${{ steps.Build.outcome == 'success' }} | |
| run: | | |
| .\build\packageExtension.ps1 -version ${{ env.GitVersion_AssemblySemVer }} -outfolder "./staging" | |
| - name: "List Package Files" | |
| shell: pwsh | |
| if: ${{ steps.Build.outcome == 'success' }} | |
| run: | | |
| Get-ChildItem -Path ./staging/ -Recurse | ForEach-Object { $_.FullName } | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Packages | |
| path: ./staging/** | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Generated | |
| path: ./docs/Reference/Generated/** | |
| # Build Docs | |
| BuildDocs: | |
| name: "Build Documentation output" | |
| runs-on: ubuntu-latest | |
| if: ${{ success() }} | |
| needs: [Setup, build] | |
| env: | |
| GitVersion_SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| GitVersion_AssemblySemVer: ${{ needs.Setup.outputs.GitVersion_AssemblySemVer }} | |
| GitVersion_InformationalVersion: ${{ needs.Setup.outputs.GitVersion_InformationalVersion }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Ruby | |
| uses: ruby/setup-ruby@v1 # v1.161.0 | |
| with: | |
| ruby-version: '3.2' # Not needed with a .ruby-version file | |
| bundler-cache: true # runs 'bundle install' and caches installed gems automatically | |
| cache-version: 0 # Increment this number if you need to re-download cached gems | |
| - uses: cschleiden/replace-tokens@v1 | |
| with: | |
| files: '["**/*.html"]' | |
| tokenPrefix: "#{" | |
| tokenSuffix: "}#" | |
| env: | |
| GitVersion_SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| GitVersion_AssemblySemVer: ${{ needs.Setup.outputs.GitVersion_AssemblySemVer }} | |
| GitVersion_InformationalVersion: ${{ needs.Setup.outputs.GitVersion_InformationalVersion }} | |
| GitVersion.SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| - uses: igsekor/[email protected] | |
| id: spellcheck | |
| name: Spellcheck | |
| - name: Build with Jekyll | |
| # Outputs to the './_site' directory by default | |
| run: bundle exec jekyll build --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL}}" | |
| env: | |
| JEKYLL_ENV: production | |
| # - name: Build Jekyll | |
| # uses: jerryjvl/jekyll-build-action@v1 | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Site | |
| path: ./_site/**/* | |
| - name: Build with Jekyll 2 | |
| # Outputs to the './_site' directory by default | |
| run: bundle exec jekyll build --destination ./_site2/ --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL_AFD}}" | |
| env: | |
| JEKYLL_ENV: production | |
| # - name: Build Jekyll | |
| # uses: jerryjvl/jekyll-build-action@v1 | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Site2 | |
| path: ./_site2/**/* | |
| # GitHubRelease | |
| GitHubRelease: | |
| name: "Release to GitHub Releases" | |
| runs-on: ubuntu-latest | |
| env: | |
| nkdAgility_Ring: ${{ needs.Setup.outputs.nkdAgility_Ring }} | |
| GitVersion_SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| GitVersion_AssemblySemVer: ${{ needs.Setup.outputs.GitVersion_AssemblySemVer }} | |
| GitVersion_InformationalVersion: ${{ needs.Setup.outputs.GitVersion_InformationalVersion }} | |
| GitVersion_NuGetVersion: ${{ needs.Setup.outputs.GitVersion_NuGetVersion }} | |
| GitVersion_PreReleaseLabel: ${{ needs.Setup.outputs.GitVersion_PreReleaseLabel }} | |
| needs: [build, Setup] | |
| if: ${{ success() && ( needs.Setup.outputs.nkdAgility_RunRelease == 'true' ) }} | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Packages | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Scripts | |
| path: ./build/ | |
| - uses: actions/create-github-app-token@v1 | |
| id: app-token | |
| with: | |
| app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} | |
| private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} | |
| - name: "Package Files" | |
| shell: pwsh | |
| run: | | |
| Get-ChildItem -Path .\ -Recurse | ForEach-Object { $_.FullName } | |
| - name: "Release options" | |
| id: release-options | |
| shell: pwsh | |
| run: | | |
| if ($Env:nkdAgility_Ring -eq 'Release') { | |
| echo "discussion_category_name=Releases" >> $env:GITHUB_OUTPUT | |
| } | |
| - name: Release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| files: | | |
| MigrationTools-*.zip | |
| nkdAgility.vsts-sync-migration-*.vsix | |
| vsts-sync-migrator.*.nupkg | |
| generate_release_notes: true | |
| tag_name: v${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| name: v${{ needs.Setup.outputs.GitVersion_SemVer }} (${{ needs.Setup.outputs.nkdAgility_Ring }}) | |
| token: ${{ steps.app-token.outputs.token }} | |
| prerelease: ${{ needs.Setup.outputs.nkdAgility_Ring != 'Release' }} | |
| discussion_category_name: ${{ steps.release-options.outputs.discussion_category_name }} | |
| draft: ${{ needs.Setup.outputs.nkdAgility_Ring == 'Canary' }} | |
| body: | | |
| ## Azure DevOps Migration Tools v${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| Version: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| Ring: (${{ needs.Setup.outputs.nkdAgility_Ring }}) | |
| --- | |
| Funding for us doing work on this tool is generally through 1) customer funding, or 2) donated free time. | |
| [Sponcer a Feature](https://github.com/sponsors/nkdAgility) | [Hire us directly](https://nkdagility.com/capabilities/azure-devops-migration-services/) | |
| --- | |
| ${{ needs.Setup.outputs.nkdAgility_ReleaseDescription }} | |
| ## Get the tools | |
| - Download the [MigrationTools-${{ needs.Setup.outputs.GitVersion_SemVer }}.zip](https://github.com/nkdAgility/azure-devops-migration-tools/releases/download/v${{ needs.Setup.outputs.GitVersion_SemVer }}/MigrationTools-${{ needs.Setup.outputs.GitVersion_SemVer }}.zip) file below | |
| - Install with Winget with `winget install ${{needs.Setup.outputs.nkdAgility_WingetApplicationId}} --version ${{ needs.Setup.outputs.GitVersion_SemVer }}` . There is a delay for aprovals on the winget store, so you may need to wait a few days before this is available. | |
| - Install with Chocolatey with `choco install vsts-sync-migrator --version ${{ needs.Setup.outputs.GitVersion_NuGetVersion }}`. There is a delay for aprovals on the chocolatey store, so you may need to wait a few hours before this is available. | |
| append_body: true | |
| # ElmahDeployment | |
| ElmahDeployemnt: | |
| name: "Create Elmah.io Deployment" | |
| runs-on: ubuntu-latest | |
| env: | |
| GitVersion_SemVer: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| needs: [GitHubRelease, Setup] | |
| if: ${{ success() && ( needs.Setup.outputs.nkdAgility_RunRelease == 'true' ) }} | |
| steps: | |
| - name: Create Deployment on elmah.io | |
| uses: elmahio/github-create-deployment-action@v1 | |
| with: | |
| apiKey: ${{ secrets.ELMAH_IO_API_KEY }} | |
| version: ${{ needs.Setup.outputs.GitVersion_SemVer }} | |
| logId: ${{ secrets.ELMAH_IO_LOG_ID }} | |
| # Release to Marketplace | |
| MarketplaceRelease: | |
| name: "Release to Marketplace" | |
| runs-on: ubuntu-latest | |
| needs: [Setup, GitHubRelease] | |
| if: ${{ success() && ( needs.Setup.outputs.nkdAgility_Ring == 'Release' ) }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| - name: "Find files" | |
| shell: pwsh | |
| run: | | |
| Get-Item -Path .\ | |
| Write-Output "Build Files" | |
| Get-ChildItem -Path .\ -Recurse -Filter '*.ps1' | ForEach-Object { $_.FullName } | |
| - name: "Marketplace" | |
| shell: pwsh | |
| run: | | |
| $vsixFile = Get-ChildItem -Path .\ -Recurse -Filter '*.vsix' | |
| if ($vsixFile -eq $null) { | |
| Write-Output "No VSIX file found" | |
| exit 1 | |
| } else { | |
| Write-Output $"Running with {$vsixFile}" | |
| } | |
| .\build\releaseExtension.ps1 -vsixFile $vsixFile.FullName -marketplaceToken ${{ secrets.VS_MARKET_TOKEN }} | |
| # Release to Chocolatey | |
| ChocolateyRelease: | |
| name: "Release to Chocolatey" | |
| runs-on: windows-latest | |
| needs: [Setup, GitHubRelease] | |
| if: ${{ success() && ( needs.Setup.outputs.nkdAgility_RunRelease == 'true' ) }} | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Packages | |
| - name: "Choco" | |
| shell: pwsh | |
| run: | | |
| $chocoFile = Get-ChildItem -Path .\ -Recurse -Filter 'vsts-sync-migrator.${{ needs.Setup.outputs.GitVersion_NuGetVersion }}.nupkg' | |
| if ($chocoFile -eq $null) { | |
| Write-Output "No Choco file found" | |
| exit 1 | |
| } else { | |
| Write-Output $"Running with {$chocoFile}" | |
| } | |
| Write-Output 'choco push "$chocoFile" --key "${{ secrets.CHOCO_APIKEY }}" --source "https://push.chocolatey.org/"' | |
| choco push "$chocoFile" --key "${{ secrets.CHOCO_APIKEY }}" --source "https://push.chocolatey.org/" | |
| # Release to Winget | |
| WingetRelease: | |
| name: "Release to Winget" | |
| runs-on: windows-latest | |
| needs: [Setup, GitHubRelease] | |
| if: ${{ success() && ( needs.Setup.outputs.nkdAgility_RunRelease == 'true' ) }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| - name: "Find files" | |
| shell: pwsh | |
| run: | | |
| Get-Item -Path .\ | |
| Write-Output "Build Files" | |
| Get-ChildItem -Path .\ -Recurse -Filter '*.ps1' | ForEach-Object { $_.FullName } | |
| - name: "Winget Release" | |
| shell: pwsh | |
| run: | | |
| .\build\releaseWingetPackage.ps1 -version ${{ needs.Setup.outputs.GitVersion_SemVer }} -ring ${{needs.Setup.outputs.nkdAgility_Ring}} -GH_TOKEN ${{ secrets.NKD_MRHINSH_TOKEN }} | |
| # Release to Docs | |
| DocsRelease: | |
| name: "Release to Docs" | |
| runs-on: ubuntu-latest | |
| needs: [Setup, BuildDocs] | |
| if: ${{ !(github.event.pull_request.head.repo.fork) }} | |
| steps: | |
| - name: Download a single artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Site | |
| path: ./_site | |
| - name: "Find files" | |
| shell: pwsh | |
| run: | | |
| Get-Item -Path .\ | |
| - name: SFTP Upload ${{ (needs.Setup.outputs.nkdAgility_Ring) }} | |
| uses: Dylan700/sftp-upload-action@latest | |
| with: | |
| server: nakedalmweb.sftp.wpengine.com | |
| username: nakedalmweb-learn | |
| password: ${{ secrets.NKDAGILITY_LEARN_SFTP }} | |
| port: 2222 | |
| # If true, outputs the results of the upload, without actually uploading. | |
| #dry-run: ${{ (needs.Setup.outputs.nkdAgility_Ring) == 'Canary' }} | |
| # A list of folders to upload in the format of `folder/ => upload_folder/` | |
| uploads: | | |
| ./_site/ => ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} | |
| # If true, any existing files in the remote upload directories are deleted. | |
| delete: false | |
| - uses: actions/create-github-app-token@v1 | |
| id: app-token | |
| with: | |
| app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} | |
| private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} | |
| - name: Download a single artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: AzureDevOpsMigrationTools-Site2 | |
| path: ./_site2 | |
| - name: Build and Deploy | |
| uses: Azure/static-web-apps-deploy@v1 | |
| id: azureDeploy | |
| with: | |
| repo_token: ${{ steps.app-token.outputs.token }} | |
| action: 'upload' | |
| app_location: ./_site2 | |
| skip_app_build: true | |
| skip_api_build: true | |
| output_location: '' | |
| deployment_environment: ${{ (needs.Setup.outputs.nkdAgility_AzureSitesEnvironment) }} | |
| azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }} | |
| - name: 'Show Summery' | |
| if: always() | |
| shell: pwsh | |
| id: nkdagility-summery | |
| run: | | |
| $markdown = @" | |
| ## ${{needs.Setup.outputs.GitVersion_SemVer}} (${{needs.Setup.outputs.nkdAgility_Ring}}) | |
| Docs deployed to [${{steps.azureDeploy.outputs.static_web_app_url}}](${{steps.azureDeploy.outputs.static_web_app_url}}) | |
| "@ | |
| echo $markdown >> $Env:GITHUB_STEP_SUMMARY |