Add workflows to manage milestones when releasing

Author: mcculls

.github/workflows/add-milestone-to-pull-requests.yaml

@@ -0,0 +1,86 @@
+name: Add milestone to pull requests
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+      - release/v*
+jobs:
+  add_milestone_to_merged:
+    name: Add milestone to merged pull requests
+    permissions:
+      issues: write # Required to update a pull request using the issues API
+      pull-requests: write # Required to update the milestone of a pull request
+    if: github.event.pull_request.merged && github.event.pull_request.milestone == null
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add milestone to merged pull requests
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # 8.0.0
+        with:
+          retries: 3
+          retry-exempt-status-codes: 400,401
+          script: |
+            // Get project milestones
+            const response = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open'
+            })
+            if (!response.data || response.data.length == 0) {
+              core.setFailed(`Failed to list milestones: ${response.status}`)
+              return
+            }
+            // Get the base branch
+            const base = '${{ github.event.pull_request.base.ref }}'
+            // Look for the matching milestone
+            let milestoneNumber = null
+            if (base == 'main') {
+              // Pick the milestone with the highest version as title using semver
+              milestoneNumber = response.data
+                .map(milestone => {
+                  // Parse version title as semver "<major>.<minor>.<patch>"
+                  const versionNumbers = milestone.title.match(/^(\d+)\.(\d+)\.(\d+)$/)
+                  if (versionNumbers == null) {
+                    return null
+                  }
+                  milestone.version = {
+                    major: parseInt(versionNumbers[1]),
+                    minor: parseInt(versionNumbers[2]),
+                    patch: parseInt(versionNumbers[3])
+                  }
+                  return milestone
+                })
+                .filter(milestone => milestone != null)
+                .sort((a, b) => {
+                  if (a.version.major != b.version.major) {
+                    return a.version.major - b.version.major
+                  }
+                  if (a.version.minor != b.version.minor) {
+                    return a.version.minor - b.version.minor
+                  }
+                  return a.version.patch - b.version.patch
+                })
+                .pop()?.number
+            } else if (base.startsWith('release/v') && base.endsWith('.x')) {
+              // Extract the minor version related to the base branch (e.g. "release/v1.2.x" -> "1.2.")
+              const version = base.substring(9, base.length - 1)
+              // Pick the milestone with title matching the extracted version
+              const versionMilestone = response.data
+                .find(milestone => milestone.title.startsWith(version))
+              if (!versionMilestone) {
+                core.setFailed(`Milestone not found for minor version: ${version}`)
+              } else {
+                milestoneNumber = versionMilestone.number
+              }
+            } else {
+              core.setFailed(`Unexpected pull request base: ${base}`)
+            }
+            // Update pull request milestone using the issues API (as pull requests are issues)
+            if (milestoneNumber != null) {
+              await github.rest.issues.update({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: ${{ github.event.pull_request.number }},
+                milestone: milestoneNumber
+              });
+            }

.github/workflows/increment-milestone-on-tag.yaml

@@ -0,0 +1,64 @@
+name: Increment milestones on tag
+on:
+  create
+permissions:
+  issues: write # Required to update milestones
+
+jobs:
+  increment_milestone:
+    if: github.event.ref_type == 'tag' && contains(github.event.ref,'-RC') == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Close current milestone
+        id: close-milestone
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # 8.0.0
+        with:
+          script: |
+            // Get the milestone title ("X.Y.Z") from tag name ("vX.Y.Z")
+            const match = '${{github.event.ref}}'.match(/v(\d+\.\d+\.\d+)/i)
+            if (!match) {
+              core.setFailed('Failed to parse tag name into milestone title: ${{github.event.ref}}')
+              return
+            }
+            const milestoneTitle = match[1]
+            // Look for the milestone from its title
+            const response = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open'
+            })
+            if (!response.data || response.data.length == 0) {
+              core.setFailed(`Failed to list milestones: ${response.status}`)
+              return
+            }
+            const milestone = response.data.find(milestone => milestone.title == milestoneTitle)
+            if (!milestone) {
+              core.setFailed(`Failed to find milestone: ${milestoneTitle}`)
+              return
+            }
+            // Close the milestone
+            await github.rest.issues.updateMilestone({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'closed',
+              milestone_number: milestone.number
+            }).catch(error => {
+              core.setFailed(`Failed to close milestone: ${error}`)
+            })
+            // Compute the next milestone version
+            const versionNumbers = milestoneTitle.split('.').map(Number)
+            if (versionNumbers[2] != 0) {
+              core.info('Closing a patch version milestone. Not opening a new one.')
+              return
+            }
+            versionNumbers[1]++
+            const nextMilestoneTitle = versionNumbers.join('.')
+            core.info(`Creating next version milestone: ${nextMilestoneTitle}`)
+            // Create the next milestone
+            await github.rest.issues.createMilestone({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: nextMilestoneTitle
+            }).catch(error => {
+              core.setFailed(`Failed to create milestone ${nextMilestoneTitle}: ${error}`)
+            })