[CI Environment] Added utility to automatically add & update all plat…

…form pipelines to the main readme (#2610) * Update to latest * Further updates to logic * Further updates * Small docs update * Updated pipeline templates * Updated pipeline templates * Updated docs * Updated docs * Added missing ref * Push updated Readme file(s) * Push updated Readme file(s) * Adjusted url gen * Push updated Readme file(s) * Added pipe name * Split URI gen * Update to latest * Push updated Readme file(s) * Push updated Readme file(s) * Renamed pipeline Co-authored-by: CARMLPipelinePrincipal <[email protected]>
Azure · Jan 24, 2023 · f16d6a9 · f16d6a9
1 parent 91831af
commit f16d6a9
Show file tree

Hide file tree

Showing 11 changed files with 482 additions and 250 deletions.
diff --git a/.azuredevops/platformPipelines/platform.updateReadMe.yml b/.azuredevops/platformPipelines/platform.updateReadMe.yml
@@ -23,9 +23,12 @@ variables:
     value: 'utilities/tools/platform/Set-ReadMeModuleTable.ps1'
   - name: relativeScriptPath_SetModuleOverviewTable
     value: 'utilities/tools/platform/Set-ModuleOverviewTable.ps1'
+  - name: relativeScriptPath_SetReadMePlatformTable
+    value: 'utilities/tools/platform/Set-ReadMePlatformTable.ps1'
 
 jobs:
-  - job: Update_module_tables
+  - job: Update_status_tables
+    displayName: Update status tables
     pool:
       ${{ if ne(variables.vmImage, '') }}:
         vmImage: ${{ variables.vmImage }}
@@ -34,8 +37,10 @@ jobs:
     steps:
       - checkout: self
         persistCredentials: true
+
+      # Update the root ReadMe Module Pipelines table ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README.md))
       - task: PowerShell@2
-        displayName: 'Update general ReadMe'
+        displayName: 'Update Module Pipelines table'
         inputs:
           targetType: inline
           pwsh: true
@@ -58,6 +63,8 @@ jobs:
             Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
             Set-ReadMeModuleTable @functionInput -Verbose
+
+      # Update the `modules` folder ReadMe ([`/modules/readme.md`](https://github.com/Azure/ResourceModules/blob/main/modules/README.md))
       - task: PowerShell@2
         displayName: 'Update module folder ReadMe'
         inputs:
@@ -82,6 +89,7 @@ jobs:
 
             Set-ReadMeModuleTable @functionInput -Verbose
 
+      # Update the module overview table ([`/docs/wiki/The library - Module overview.md`](https://github.com/Azure/ResourceModules/wiki/The%20library%20-%20Module%20overview))
       - task: PowerShell@2
         displayName: 'Update module outline'
         inputs:
@@ -101,6 +109,29 @@ jobs:
 
             Set-ModuleOverviewTable @functionInput -Verbose
 
+      # Update the root ReadMe Platform Pipelines table ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README.md))
+      - task: PowerShell@2
+        displayName: 'Update Platform Pipelines table'
+        inputs:
+          targetType: inline
+          pwsh: true
+          script: |
+            # Load used functions
+            . (Join-Path '$(System.DefaultWorkingDirectory)' '$(relativeScriptPath_SetReadMePlatformTable)')
+
+            $functionInput = @{
+              FilePath       = Join-Path '$(System.DefaultWorkingDirectory)' 'README.md'
+              RepositoryName = '$(Build.Repository.Name)'
+              Organization   = '$(System.CollectionUri)'.Split('/')[3]
+              ProjectName    = '$(System.TeamProject)'
+              Environment    = 'ADO'
+            }
+
+            Write-Verbose "Invoke task with" -Verbose
+            Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
+            Set-ReadMePlatformTable @functionInput -Verbose
+
       - task: PowerShell@2
         displayName: 'Push changes'
         inputs:

diff --git a/.github/workflows/platform.updateReadMe.yml b/.github/workflows/platform.updateReadMe.yml
@@ -2,7 +2,7 @@
 # This pipeline requires a secret 'PLATFORM_REPO_UPDATE_PAT' set up in the GitHub secrets.
 # The secret's value should be a PAT token with the permissions to push to the repository's main branch.
 
-name: '.Platform: Update ReadMe Module Tables'
+name: '.Platform: Update ReadMe status Tables'
 
 on:
   workflow_dispatch:
@@ -19,18 +19,21 @@ env:
   pipelinePrincipalGitUserEmail: '[email protected]'
   relativeScriptPath_SetReadMeModuleTable: 'utilities/tools/platform/Set-ReadMeModuleTable.ps1'
   relativeScriptPath_SetModuleOverviewTable: 'utilities/tools/platform/Set-ModuleOverviewTable.ps1'
+  relativeScriptPath_SetReadMePlatformTable: 'utilities/tools/platform/Set-ReadMePlatformTable.ps1'
 
 jobs:
   job_update_readme:
     runs-on: ubuntu-20.04
-    name: 'Update module tables'
+    name: 'Update status tables'
     steps:
       - name: 'Checkout'
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
           token: '${{ secrets.PLATFORM_REPO_UPDATE_PAT }}' # Sets general GIT credentials up
-      - name: 'Update general ReadMe'
+
+      # Update the root ReadMe Module Pipelines table ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README.md))
+      - name: 'Update Module Pipelines table'
         shell: pwsh
         run: |
           # Load used functions
@@ -51,6 +54,7 @@ jobs:
 
           Set-ReadMeModuleTable @functionInput -Verbose
 
+      # Update the `modules` folder ReadMe ([`/modules/readme.md`](https://github.com/Azure/ResourceModules/blob/main/modules/README.md))
       - name: 'Update module folder ReadMe'
         shell: pwsh
         run: |
@@ -71,6 +75,7 @@ jobs:
 
           Set-ReadMeModuleTable @functionInput -Verbose
 
+      # Update the module overview table ([`/docs/wiki/The library - Module overview.md`](https://github.com/Azure/ResourceModules/wiki/The%20library%20-%20Module%20overview))
       - name: 'Update module outline'
         shell: pwsh
         run: |
@@ -87,6 +92,25 @@ jobs:
 
           Set-ModuleOverviewTable @functionInput -Verbose
 
+      # Update the root ReadMe Platform Pipelines table ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README.md))
+      - name: 'Update Platform Pipelines table'
+        shell: pwsh
+        run: |
+          # Load used functions
+          . (Join-Path $env:GITHUB_WORKSPACE $env:relativeScriptPath_SetReadMePlatformTable)
+
+          $functionInput = @{
+            FilePath       = Join-Path $env:GITHUB_WORKSPACE 'README.md'
+            RepositoryName = ($env:GITHUB_REPOSITORY).split('/')[1]
+            Organization   = ($env:GITHUB_REPOSITORY).split('/')[0]
+            Environment    = 'GitHub'
+          }
+
+          Write-Verbose "Invoke task with" -Verbose
+          Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
+          Set-ReadMePlatformTable @functionInput -Verbose
+
       - name: 'Push changes'
         shell: pwsh
         run: |