Merge pull request #1243 from MobilityData/feat-next-release-milestone-2025-06-05

Author: fredericsimard

.github/workflows/assign_next_release_milestone.yml

@@ -0,0 +1,50 @@
+name: Assign `Next Release` Milestone
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'README.md'
+      - 'LICENSE'
+      - '.gitignore'
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'To run in test mode (no changes made), set to true'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  assign-milestone:
+    runs-on: ubuntu-22.04
+    
+    steps:
+
+      - name: Load secrets from 1Password
+        id: onepw_secrets
+        uses: 1password/[email protected]
+        with:
+            export-env: true
+        env:
+            OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            GH_TOKEN: "op://rbiv7rvkkrsdlpcrz3bmv7nmcu/GitHub generic action token for all repos/credential"
+     
+      - name: Checkout repository
+        uses: actions/[email protected]
+        
+      - name: Setup Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 22
+          
+      - name: Install dependencies
+        run: npm install @octokit/rest
+        
+      - name: Run milestone assignment
+        env:
+          GITHUB_TOKEN: ${{ env.GH_TOKEN }}
+          GITHUB_REPOSITORY: ${{ github.repository }}
+          DRY_RUN: ${{ github.event.inputs.dry_run || 'false' }}
+        run: node .github/scripts/assign-next-release-milestone.js

scripts/assign-next-release-milestone.js

@@ -0,0 +1,171 @@
+#!/usr/bin/env node
+/**
+ * GitHub Milestone Assignment Script
+ * Assigns "next release" milestone to closed issues when merged to main
+ * 
+ * Usage:
+ * 
+ * 1. Setup Environment variables to run locally:
+ *   export GITHUB_TOKEN="ghp_your_token_here"
+ *   export GITHUB_REPOSITORY="MobilityData/mobility-feed-api"
+ * 
+ * 2. Install dependencies
+ *   npm install @octokit/rest
+ * 
+ * 3. Run in dry mode
+ *   node scripts/assign-next-release-milestone.js --dry-run
+ * - Optional. If provided then the script will do a dry run without affecting any issues, logging will explain what will be done when running in production mode.
+ * 
+ * 4. Run in production mode
+ *   node scripts/assign-next-release-milestone.js
+ */
+
+const { Octokit } = require('@octokit/rest');
+
+// Parse command line arguments
+const args = process.argv.slice(2);
+const hasArgDryRun = args.includes('--dry-run');
+
+// Determine dry run mode based on priority:
+// 1. Command line argument --dry-run takes precedence
+// 2. Environment variable DRY_RUN
+// 3. Default to false
+const isDryRun = hasArgDryRun || process.env.DRY_RUN === 'true';
+
+// Validate required environment variables
+const token = process.env.GITHUB_TOKEN;
+const repository = process.env.GITHUB_REPOSITORY;
+
+if (!token) {
+  console.error('❌ GITHUB_TOKEN environment variable is required');
+  process.exit(1);
+}
+
+if (!repository) {
+  console.error('❌ GITHUB_REPOSITORY environment variable is required (format: owner/repo)');
+  process.exit(1);
+}
+
+const [owner, repo] = repository.split('/');
+if (!owner || !repo) {
+  console.error('❌ GITHUB_REPOSITORY must be in format "owner/repo"');
+  process.exit(1);
+}
+
+// Initialize Octokit
+const octokit = new Octokit({
+  auth: token,
+});
+
+async function main() {
+  try {
+    if (isDryRun) {
+      console.log('RUNNING IN DRY RUN MODE - No changes will be made');
+    }
+    
+    console.log(`Processing repository: ${owner}/${repo}`);
+
+    // Get the "next release" milestone
+    console.log('Fetching milestones...');
+    const milestones = await octokit.rest.issues.listMilestones({
+      owner,
+      repo,
+      state: 'open'
+    });
+
+    const nextReleaseMilestone = milestones.data.find(
+      milestone => milestone.title.toLowerCase() === 'next release'
+    );
+
+    if (!nextReleaseMilestone) {
+      console.log('❌ "Next Release" milestone not found');
+      return;
+    }
+
+    console.log(`Found milestone: ${nextReleaseMilestone.title} (ID: ${nextReleaseMilestone.number})`);
+
+    // Get all closed issues
+    console.log('Fetching closed issues...');
+    const issues = await octokit.rest.issues.listForRepo({
+      owner,
+      repo,
+      state: 'closed',
+      per_page: 100
+    });
+
+    console.log(`Found ${issues.data.length} closed issues`);
+
+    let processedCount = 0;
+    let assignedCount = 0;
+
+    // Process each issue
+    for (const issue of issues.data) {
+      // Skip pull requests (they appear in issues API but have pull_request property)
+      if (issue.pull_request) {
+        continue;
+      }
+
+      processedCount++;
+
+      // Skip if already has the next release milestone
+      if (issue.milestone && issue.milestone.number === nextReleaseMilestone.number) {
+        console.log(`Issue #${issue.number} already has Next Release milestone, skipping...`);
+        continue;
+      }
+
+      // Check if issue was closed by a merged PR
+      console.log(`Checking timeline for issue #${issue.number}...`);
+      const timelineEvents = await octokit.rest.issues.listEventsForTimeline({
+        owner,
+        repo,
+        issue_number: issue.number
+      });
+
+      const wasMergedToMain = timelineEvents.data.some(event => {
+        return event.event === 'closed' && 
+               event.commit_id && 
+               event.source && 
+               event.source.issue && 
+               event.source.issue.pull_request &&
+               event.source.issue.pull_request.merged_at;
+      });
+
+      if (wasMergedToMain) {
+        console.log(`${isDryRun ? '[DRY RUN] Would assign' : 'Assigning'} milestone to issue #${issue.number}: ${issue.title}`);
+
+        if (!isDryRun) {
+          try {
+            await octokit.rest.issues.update({
+              owner,
+              repo,
+              issue_number: issue.number,
+              milestone: nextReleaseMilestone.number
+            });
+
+            console.log(`✅ Successfully assigned milestone to issue #${issue.number}`);
+            assignedCount++;
+          } catch (error) {
+            console.error(`❌ Failed to assign milestone to issue #${issue.number}:`, error.message);
+          }
+        } else {
+          console.log(`[DRY RUN] Skipped actual assignment for issue #${issue.number}`);
+          assignedCount++;
+        }
+      } else {
+        console.log(`Issue #${issue.number} was not merged to main, skipping`);
+      }
+    }
+
+    console.log(`\n\nSummary:`);
+    console.log(`- Processed ${processedCount} issues`);
+    console.log(`- ${isDryRun ? 'Would assign' : 'Assigned'} milestone to ${assignedCount} issues`);
+    console.log(`${isDryRun ? '[DRY RUN] Test complete!' : '✅ Milestone assignment complete!'}`);
+
+  } catch (error) {
+    console.error('❌ Script failed:', error.message);
+    process.exit(1);
+  }
+}
+
+// Run the script
+main();