chore: add addedon field automation in prioritization board (#33856)

godwingrs22 · web-flow · commit 09235fd02418 · 2025-03-26T18:46:47.000Z
### Issue # (if applicable) NA ### Reason for this change Currently in the Prioritization dasboard, we don't have a way to filter the PRs and Issues by date when it is added. ### Description of changes This PR enables automation for adding current date to the `AddedOn` column field in the Github Prioritization dasboard whenever new PR/Issues are being added to the dashboard. ### Describe any new or updated permissions being added NA ### Description of how you validated changes Tested in test dashboard. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -128,3 +128,8 @@ Owner: CDK Support team
 
 [project-prioritization-needs-attention.yml](project-prioritization-needs-attention.yml): GitHub action that runs every day to update Needs Attention field in the prioritization project board.
 Owner: CDK Support team
+
+### PR Prioritization AddedOn update
+
+[project-prioritization-added-on.yml](project-prioritization-added-on.yml): GitHub action that runs every day to update AddedOn field in the prioritization project board.
+Owner: CDK Support team
diff --git a/.github/workflows/project-prioritization-added-on.yml b/.github/workflows/project-prioritization-added-on.yml
@@ -0,0 +1,21 @@
+name: PR Prioritization AddedOn update
+
+on:
+  schedule:
+    - cron: '0 */6 * * 1-5'  # Runs every 6 hours during weekdays
+  workflow_dispatch:        # Manual trigger
+
+jobs:
+  update_added_on:
+    if: github.repository == 'aws/aws-cdk'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name:  Update AddedOn field
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
+          script: |
+            const script = require('./scripts/prioritization/update-added-on.js')
+            await script({github})
diff --git a/scripts/prioritization/assign-bug-priority.js b/scripts/prioritization/assign-bug-priority.js
@@ -1,6 +1,7 @@
 const { PRIORITIES, LABELS, STATUS, ...PROJECT_CONFIG } = require('./project-config');
 const {
     updateProjectField,
+    updateProjectDateField,
     addItemToProject,
     fetchProjectFields,
     fetchProjectItem,
@@ -74,7 +75,7 @@ module.exports = async ({ github, context }) => {
                 (option) => option.name === STATUS.READY
             )?.id;
 
-            // Set both priority and Ready status for new items only
+            // Set priority, Ready status and current date for new items
             await Promise.all([
                 updateProjectField({
                     github,
@@ -89,7 +90,14 @@ module.exports = async ({ github, context }) => {
                     itemId: itemId,
                     fieldId: PROJECT_CONFIG.statusFieldId,
                     value: readyStatusId,
-                })
+                }),
+                updateProjectDateField({
+                    github,
+                    projectId: PROJECT_CONFIG.projectId,
+                    itemId: itemId,
+                    fieldId: PROJECT_CONFIG.addedOnFieldId,
+                    date: new Date().toISOString(),
+                  })
             ]);
         }
     }
diff --git a/scripts/prioritization/assign-priority.js b/scripts/prioritization/assign-priority.js
@@ -10,6 +10,7 @@
 const { PRIORITIES, LABELS, STATUS, ...PROJECT_CONFIG } = require('./project-config');
 const {
   updateProjectField,
+  updateProjectDateField,
   addItemToProject,
   fetchProjectFields,
   fetchProjectItem,
@@ -129,7 +130,7 @@ module.exports = async ({ github, context }) => {
           (option) => option.name === STATUS.READY
         )?.id;
 
-        // Set both priority and Ready status for new items
+        // Set priority, Ready status and current date for new items
         await Promise.all([
           updateProjectField({
             github,
@@ -144,6 +145,13 @@ module.exports = async ({ github, context }) => {
             itemId: itemId,
             fieldId: PROJECT_CONFIG.statusFieldId,
             value: readyStatusId,
+          }),
+          updateProjectDateField({
+            github,
+            projectId: PROJECT_CONFIG.projectId,
+            itemId: itemId,
+            fieldId: PROJECT_CONFIG.addedOnFieldId,
+            date: new Date().toISOString(),
           })
         ]);
       }
diff --git a/scripts/prioritization/assign-r2-priority.js b/scripts/prioritization/assign-r2-priority.js
@@ -9,6 +9,7 @@ const { PRIORITIES, LABELS, STATUS, ...PROJECT_CONFIG } = require("./project-con
 
 const {
   updateProjectField,
+  updateProjectDateField,
   addItemToProject,
   fetchProjectFields,
   fetchOpenPullRequests,
@@ -126,7 +127,7 @@ module.exports = async ({ github }) => {
         });
         itemId = addResult.addProjectV2ItemById.item.id;
 
-        // Set both priority and initial status for new items
+        // Set priority, Ready status and current date for new items
         await Promise.all([
           updateProjectField({
             github,
@@ -141,6 +142,13 @@ module.exports = async ({ github }) => {
             itemId: itemId,
             fieldId: PROJECT_CONFIG.statusFieldId,
             value: readyStatusId,
+          }),
+          updateProjectDateField({
+            github,
+            projectId: PROJECT_CONFIG.projectId,
+            itemId: itemId,
+            fieldId: PROJECT_CONFIG.addedOnFieldId,
+            date: new Date().toISOString(),
           })
         ]);
       }
diff --git a/scripts/prioritization/assign-r5-priority.js b/scripts/prioritization/assign-r5-priority.js
@@ -10,6 +10,7 @@ const { PRIORITIES, LABELS, STATUS, DAYS_THRESHOLD, ...PROJECT_CONFIG } = requir
 
 const {
   updateProjectField,
+  updateProjectDateField,
   addItemToProject,
   fetchProjectFields,
   fetchOpenPullRequests,
@@ -120,7 +121,7 @@ module.exports = async ({ github }) => {
         contentId: pr.id,
       });
 
-      // Set initial priority and status
+      // Set priority, Ready status and current date for new items
       await Promise.all([
         updateProjectField({
           github,
@@ -135,6 +136,13 @@ module.exports = async ({ github }) => {
           itemId: addResult.addProjectV2ItemById.item.id,
           fieldId: PROJECT_CONFIG.statusFieldId,
           value: readyStatusId,
+        }),
+        updateProjectDateField({
+          github,
+          projectId: PROJECT_CONFIG.projectId,
+          itemId: itemId,
+          fieldId: PROJECT_CONFIG.addedOnFieldId,
+          date: new Date().toISOString(),
         })
       ]);
     } catch (error) {
diff --git a/scripts/prioritization/project-api.js b/scripts/prioritization/project-api.js
@@ -35,7 +35,45 @@ const updateProjectField = async ({
       }
     );
   };
-  
+
+/**
+ * Updates a date field value for an item in a GitHub Project.
+ * @param {Object} params - The parameters for updating the project field
+ * @param {Object} params.github - The GitHub API client
+ * @param {string} params.projectId - The ID of the project
+ * @param {string} params.itemId - The ID of the item to update
+ * @param {string} params.fieldId - The ID of the field to update
+ * @param {string} params.date - The date string in ISO format
+ * @returns {Promise<Object>} The GraphQL mutation response
+ */
+const updateProjectDateField = async ({
+  github,
+  projectId,
+  itemId,
+  fieldId,
+  date,
+}) => {
+  return github.graphql(
+    `
+      mutation($input: UpdateProjectV2ItemFieldValueInput!) {
+        updateProjectV2ItemFieldValue(input: $input) {
+          projectV2Item {
+            id
+          }
+        }
+      }
+    `,
+    {
+      input: {
+        projectId,
+        itemId,
+        fieldId,
+        value: { date },
+      },
+    }
+  );
+};
+
 /**
  * Adds an item (PR) to a GitHub Project.
  * @param {Object} params - The parameters for adding an item to the project
@@ -233,6 +271,18 @@ const updateProjectField = async ({
             items(first: 100, after: $cursor) {
               nodes {
                 id
+                createdAt
+                type
+                content {
+                  ... on Issue {
+                    id
+                    number
+                  }
+                  ... on PullRequest {
+                    id
+                    number
+                  }
+                }
                 fieldValues(first: 20) {
                   nodes {
                     ... on ProjectV2ItemFieldSingleSelectValue {
@@ -244,6 +294,14 @@ const updateProjectField = async ({
                       }
                       updatedAt
                     }
+                    ... on ProjectV2ItemFieldDateValue {
+                      date
+                      field {
+                        ... on ProjectV2Field {
+                          name
+                        }
+                      }
+                    }
                   }
                 }
               }
@@ -261,6 +319,7 @@ const updateProjectField = async ({
 
   module.exports = {
     updateProjectField,
+    updateProjectDateField,
     addItemToProject,
     fetchProjectFields,
     fetchOpenPullRequests,
diff --git a/scripts/prioritization/project-config.js b/scripts/prioritization/project-config.js
@@ -45,7 +45,7 @@ const NEEDS_ATTENTION_STATUS = {
 
 /**
  * Project configuration for GitHub project automation.
- * Note: For projectId, priorityFieldId, statusFieldId, and attentionFieldId,
+ * Note: For projectId, priorityFieldId, statusFieldId, attentionFieldId and addedOnFieldId,
  * refer to Setup section in README.md on how to retrieve these values using GraphQL query.
  * These IDs need to be updated only when project fields are modified.
  */
@@ -57,6 +57,7 @@ module.exports = {
   priorityFieldId: 'PVTSSF_lADOACIPmc4Av_32zgmVmPs',
   statusFieldId: 'PVTSSF_lADOACIPmc4Av_32zgmVmF8',
   attentionFieldId: 'PVTSSF_lADOACIPmc4Av_32zgmZDdo',
+  addedOnFieldId: 'PVTF_lADOACIPmc4Av_32zgqbglg',
   LABELS,
   PRIORITIES,
   STATUS,
diff --git a/scripts/prioritization/update-added-on.js b/scripts/prioritization/update-added-on.js
@@ -0,0 +1,94 @@
+/**
+ * Updates the "Added On" date for project items that have empty "Added On" field
+ * by using the project item's createdAt timestamp from GitHub API.
+ * This handles items that were added to the board manually.
+ */
+
+const { ...PROJECT_CONFIG } = require('./project-config');
+const {
+  fetchProjectItems,
+  updateProjectDateField,
+} = require('./project-api');
+
+module.exports = async ({ github }) => {
+  // Get today's date at start of day (UTC)
+  const today = new Date();
+  today.setUTCHours(0, 0, 0, 0);
+
+  try {
+    let allItems = [];
+    let hasNextPage = true;
+    let cursor = null;
+
+    // Fetch project items with pagination
+    while (hasNextPage) {
+      const result = await fetchProjectItems({
+        github,
+        org: PROJECT_CONFIG.org,
+        number: PROJECT_CONFIG.projectNumber,
+        cursor,
+      });
+
+      const items = result.organization.projectV2.items;
+      
+      // Filter items created today
+      const todayItems = items.nodes.filter(item => {
+        const itemDate = new Date(item.createdAt);
+        return itemDate >= today;
+      });
+
+      if (todayItems.length > 0) {
+        allItems = allItems.concat(todayItems);
+      }
+
+      hasNextPage = items.pageInfo.hasNextPage;
+      cursor = items.pageInfo.endCursor;
+    }
+
+    console.log(`Processing ${allItems.length} items created today for AddedOn dates`);
+
+    // Process each item
+    for (const item of allItems) {
+      const itemType = item.type;
+      const itemNumber = item.content?.number;
+
+      try {
+        // Find the AddedOn field value
+        const addedOnField = item.fieldValues.nodes.find(
+          (field) => field.field?.name === 'AddedOn'
+        );
+
+        // If AddedOn is empty
+        if (!addedOnField || !addedOnField.date) {
+          console.log(`Processing ${itemType} #${itemNumber} - Adding missing AddedOn date`);
+
+          await updateProjectDateField({
+            github,
+            projectId: PROJECT_CONFIG.projectId,
+            itemId: item.id,
+            fieldId: PROJECT_CONFIG.addedOnFieldId,
+            date: item.createdAt,
+          });
+
+          console.log(`Updated AddedOn date for ${itemType} #${itemNumber} with creation date ${item.createdAt}`);
+        } else {
+          console.log(`Skipping ${itemType} #${itemNumber} - AddedOn date already set`);
+        }
+      } catch (error) {
+        console.error(`Error processing ${itemType} #${itemNumber}:`, error.message);
+        continue;
+      }
+    }
+
+    if (allItems.length === 0) {
+      console.log('No items found that were created today');
+    } else {
+      console.log(`Successfully processed ${allItems.length} items`);
+    }
+    
+    console.log('Completed processing today\'s items for AddedOn dates');
+  } catch (error) {
+    console.error('Error updating AddedOn dates:', error.message);
+    throw error;
+  }
+};
