[ci] Use pipeline to update gather-docs.yaml during releases

common/config/azure-pipelines/jobs/check-gather-docs.yaml

@@ -1,38 +1,38 @@
-name: check-gather-docs
-trigger: none
+# name: check-gather-docs
+# trigger: none
 
-resources:
-  pipelines:
-  - pipeline: 'itwinjs'
-    source: iTwin.js/iTwin.js
-    trigger:
-      enabled: true
-      branches:
-        include:
-          - release/*
-      tags:
-        - 'package-release'
+# resources:
+#   pipelines:
+#   - pipeline: 'itwinjs'
+#     source: iTwin.js/iTwin.js
+#     trigger:
+#       enabled: true
+#       branches:
+#         include:
+#           - release/*
+#       tags:
+#         - 'package-release'
 
-jobs:
-  - job: check-gather-docs
-    displayName: 'Check and update gather-docs.yaml branch'
-    pool:
-      vmImage: 'ubuntu-latest'
+# jobs:
+#   - job: check-gather-docs
+#     displayName: 'Check and update gather-docs.yaml branch'
+#     pool:
+#       vmImage: 'ubuntu-latest'
 
-    variables:
-      - group: imodel-native-secret-variables
+#     variables:
+#       - group: imodel-native-secret-variables
 
-    steps:
-      - checkout: self
-        persistCredentials: true
-        clean: true
+#     steps:
+#       - checkout: self
+#         persistCredentials: true
+#         clean: true
 
-      - script: |
-          node common/scripts/check_gather_docs.mjs
-          git add .
-          git commit -m "Update gather-docs.yaml"
-          git push --set-upstream https://$(GH_TOKEN)@github.com/iTwin/itwinjs-core $(Build.SourceBranchName)
-        displayName: 'Check gather-docs.yaml branch'
-        env:
-          GITHUB_TOKEN: $(GH_TOKEN)
-          CURRENT_BRANCH: $(Build.SourceBranch)
+#       - script: |
+#           node common/scripts/check_gather_docs.mjs
+#           git add .
+#           git commit -m "Update gather-docs.yaml"
+#           git push --set-upstream https://$(GH_TOKEN)@github.com/iTwin/itwinjs-core $(Build.SourceBranchName)
+#         displayName: 'Check gather-docs.yaml branch'
+#         env:
+#           GITHUB_TOKEN: $(GH_TOKEN)
+#           CURRENT_BRANCH: $(Build.SourceBranch)

common/config/azure-pipelines/templates/publish.yaml

@@ -38,3 +38,14 @@ steps:
     PathtoPublish: '$(Build.ArtifactStagingDirectory)/imodeljs/packages'
     ArtifactName: packages
   condition: and(succeeded(), in(variables['Build.Reason'], 'IndividualCI', 'Schedule', 'Manual'), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['ShouldPublish'], 'True'))
+
+- script: |
+    node common/scripts/check_gather_docs.mjs
+    git add .
+    git commit -m "Update gather-docs.yaml"
+    git push --set-upstream https://$(GH_TOKEN)@github.com/iTwin/itwinjs-core $(Build.SourceBranchName)
+  displayName: 'Check gather-docs.yaml branch'
+  condition: and(succeeded(), in(variables['Build.Reason'], 'IndividualCI', 'Schedule', 'Manual'), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['ShouldPublish'], 'True'))
+  env:
+    GITHUB_TOKEN: $(GH_TOKEN)
+    CURRENT_BRANCH: $(Build.SourceBranch)

common/scripts/check_gather_docs.mjs

@@ -33,6 +33,13 @@ function checkFile(filePath, currentBranch) {
 function main() {
   const filePath = path.normalize("./common/config/azure-pipelines/templates/gather-docs.yaml")
   const currentBranch = process.env.CURRENT_BRANCH;
+
+  const textToFind = /refs\/heads\/release\/\d+\.\d+\.x/gi;
+  if (!currentBranch.match(textToFind)) {
+    console.error("Invalid branch name.");
+    process.exit(1);
+  }
+
   checkFile(filePath, currentBranch);
 }
 main();