ci: add PR for OpenAPI files

Author: MIchaelMainer

.azure-pipelines/generation-templates/capture-metadata.yml

@@ -166,9 +166,9 @@ steps:
 
 # Checkin clean metadata into metadata repo or make it an artifact.
 - pwsh: '$(scriptsDirectory)/git-push-cleanmetadata.ps1'
-
-  displayName: push clean ${{ parameters.endpoint }} metadata to msgraph-metadata repo
+  displayName: push clean ${{ parameters.endpoint }} CSDL metadata to msgraph-metadata repo
   env:
+    CreatePR: False
     EndpointVersion: ${{ parameters.endpoint }}
     PublishChanges: $(publishChanges)
   workingDirectory: '$(Build.SourcesDirectory)/msgraph-metadata'

.azure-pipelines/generation-templates/capture-openapi.yml

@@ -159,7 +159,31 @@ jobs:
   - pwsh: '$(scriptsDirectory)/git-push-cleanmetadata.ps1'
     displayName: push clean ${{ parameters.endpoint }} OpenAPI description to msgraph-metadata repo
     env:
+      CreatePR: True      
       EndpointVersion: ${{ parameters.endpoint }}
       PublishChanges: $(publishChanges)
     workingDirectory: '$(Build.SourcesDirectory)/msgraph-metadata'
     enabled: true
+
+  # Create PR - note that this PR is not used for gating. It's just for discovery purposes. Library generation PRs will still
+  # be created based on the OpenAPI files.
+
+  - task: AzureKeyVault@2
+    displayName: "Azure Key Vault: Get Secrets"
+    inputs:
+      azureSubscription: "Federated AKV Managed Identity Connection"
+      KeyVaultName: akv-prod-eastus
+      SecretsFilter: "microsoft-graph-devx-bot-appid,microsoft-graph-devx-bot-privatekey"
+
+  - pwsh: '$(scriptsDirectory)/create-pull-request.ps1'
+    displayName: 'Create Pull Request for the generated OpenAPI files for msgraph-metadata'
+    env:
+      BaseBranch: master
+      GeneratePullRequest: true
+      GhAppId: $(microsoft-graph-devx-bot-appid)
+      GhAppKey: $(microsoft-graph-devx-bot-privatekey)
+      OverrideSkipCI: false
+      RepoName: 'microsoftgraph/msgraph-metadata'
+      ScriptsDirectory: $(scriptsDirectory)
+      Version: ''
+    workingDirectory: '$(Build.SourcesDirectory)/msgraph-metadata'

scripts/create-pull-request.ps1

@@ -9,6 +9,8 @@ if (($env:GeneratePullRequest -eq $False)) { # Skip CI if manually running this
     return;
 }
 
+$version = $env:Version
+
 # Special case for beta typings as it uses a non-conforming preview versioning.
 if ($env:RepoName.Contains("msgraph-beta-typescript-typings"))
 {
@@ -18,7 +20,6 @@ else {
     $title = "Generated $version models and request builders"
 }
 
-$version = $env:Version
 $body = ":bangbang:**_Important_**:bangbang: <br> Check for unexpected deletions or changes in this PR and ensure relevant CI checks are passing. <br><br> **Note:** This pull request was automatically created by Azure pipelines."
 $baseBranchParameter = ""
 

scripts/git-push-cleanmetadata.ps1

@@ -2,6 +2,10 @@
 # Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the 
 # project root for license information.
 
+# Referenced by:
+# capture-metadata.yml
+# capture-openapi.yml
+
 # This script stashes any changes, checks out the latest master branch, applies the stashed changes, commits, and 
 # pushes the changes back to the remote repository.
 
@@ -31,6 +35,12 @@ git stash pop | Write-Host -ForegroundColor Yellow
 Write-Host "`nGet status:" -ForegroundColor Green
 git status | Write-Host -ForegroundColor Yellow
 
+if ($env:CreatePR -eq $True)
+{
+    Write-Host "`nCreate branch: $env:BUILD_BUILDID/updateOpenAPI" -ForegroundColor Green
+    git checkout -B $env:BUILD_BUILDID/updateOpenAPI | Write-Host -ForegroundColor Yellow
+}
+
 Write-Host "`nStaging clean $env:EndpointVersion metadata files....." -ForegroundColor Green
 git add . | Write-Host -ForegroundColor Yellow
 
@@ -51,11 +61,21 @@ else
 Write-Host "`nGet status:" -ForegroundColor Green
 git status | Write-Host -ForegroundColor Yellow
 
-Write-Host "`nRunning: git pull origin master --rebase..." -ForegroundColor Green
-# sync branch before pushing
-# this is especially important while running v1 and beta in parallel
-# and one process goes out of sync because of the other's check-in
-git pull origin master --rebase | Write-Host -ForegroundColor Yellow
+if ($env:CreatePR -eq $True)
+{
+    Write-Host "`nPushing branch for PR creation" -ForegroundColor Green
+
+    Write-Host "`ngit push --set-upstream origin $env:BUILD_BUILDID/updateOpenAPI:" -ForegroundColor Green
+    git push --set-upstream origin $env:BUILD_BUILDID/updateOpenAPI | Write-Host -ForegroundColor Yellow
+}
+else # original behavior: push to master
+{
+    Write-Host "`nRunning: git pull origin master --rebase..." -ForegroundColor Green
+    # sync branch before pushing
+    # this is especially important while running v1 and beta in parallel
+    # and one process goes out of sync because of the other's check-in
+    git pull origin master --rebase | Write-Host -ForegroundColor Yellow
 
-Write-Host "`nRunning: git push --set-upstream origin master ..." -ForegroundColor Green
-git push --set-upstream origin master | Write-Host -ForegroundColor Yellow
+    Write-Host "`nRunning: git push --set-upstream origin master ..." -ForegroundColor Green
+    git push --set-upstream origin master | Write-Host -ForegroundColor Yellow
+}