Create new GHA to add comments to Skills Issue in re: event activities

.github/workflows/activity-trigger.yml

@@ -0,0 +1,40 @@
+name: Member Activity Trigger
+
+on:
+  workflow_call:
+  issues:
+    types: [opened, assigned, unassigned, closed]
+  issue_comment: 
+    types: [created]
+  pull_request:
+    types: [opened, closed]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  Gather-Activity-Event-Information:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Gather Event Details
+      id: gather-event-details
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ secrets.HACKFORLA_GRAPHQL_TOKEN }}
+        script: |
+          const script = require('./github-actions/activity-trigger/activity-trigger.js')
+          const activity = script({g: github, c: context})
+          return activity
+
+    - if: ${{ steps.gather-event-details.outputs.result  != '[]' }}
+      name: Post to Skills Issue
+      id: post-to-skills-issue
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ secrets.HACKFORLA_GRAPHQL_TOKEN }}
+        script: |
+          const activity = ${{ steps.gather-event-details.outputs.result }}
+          const script = require('./github-actions/activity-trigger/post-to-skills-issue.js')
+          script({g: github, c: context}, activity)
+

github-actions/activity-trigger/activity-trigger.js

@@ -0,0 +1,123 @@
+/**
+ * This function is triggered by member activities, which include:
+ *    the eventName (i.e. "issues", "pull_request", "pull_request_review", etc. ), 
+ *    the eventAction (i.e. "opened", "assigned", "submitted", etc.), and
+ *    the eventActor (user who is credited for the event).
+ * @param {Object} github    - GitHub object from function calling activity-trigger.js
+ * @param {Object} context   - Context of the function calling activity-trigger.js
+ * @returns {Object}         - An object containing the eventActor and a message
+ */
+async function activityTrigger({g, c}) {
+
+    github = g;
+    context = c;
+
+    let issueNum = '';
+    let assignee = '';
+    let timeline = '';
+
+    let eventName = context.eventName;
+    let eventAction = context.payload.action;
+    let eventActor = context.actor;
+    let activity = [];
+
+    const excludedActors = ['HackforLABot', 'elizabethhonest'];
+
+    if (eventName === 'issues') {
+        issueNum = context.payload.issue.number;
+        eventUrl = context.payload.issue.html_url;
+        timeline = context.payload.issue.updated_at;
+        // If issue action is not opened and an assignee exists, then change
+        // the eventActor to the issue assignee, else retain issue author
+        assignee = context.payload.assignee?.login;
+        if (eventAction != 'opened' && assignee != null ) {
+            console.log(`Issue is ${eventAction}. Change eventActor => ${assignee}`);
+            eventActor = assignee;
+        } else {
+            eventActor = context.payload.issue.user.login;
+        }
+        if (eventAction === 'closed') {
+            let reason = context.payload.issue.state_reason;
+            eventAction = reason;
+        }
+    } else if (eventName === 'issue_comment') {
+        issueNum = context.payload.issue.number;
+        eventUrl = context.payload.comment.html_url;
+        timeline = context.payload.comment.updated_at;
+    } else if (eventName === 'pull_request') {
+        issueNum = context.payload.pull_request.number;
+        eventUrl = context.payload.pull_request.html_url;
+        timeline = context.payload.pull_request.updated_at;
+        // If PR closed, check if merged and change eventActor to the original pr author
+        if (eventAction === 'closed') {
+            eventAction = context.payload.pull_request.merged ? 'merged' : 'closed';
+            eventActor = context.payload.pull_request.user.login;
+        }
+    } else if (eventName === 'pull_request_review') {
+        issueNum = context.payload.pull_request.number;
+        eventUrl = context.payload.review.html_url;
+        timeline = context.payload.review.updated_at;
+    }
+
+    // Following are for confirmation, can be removed
+    console.log(`eventName = ${eventName}`);
+    console.log(`eventAction = ${eventAction}`);
+    console.log(`eventActor = ${eventActor}`);
+    console.log(`issueNum = ${issueNum}`);
+    console.log(`eventUrl = ${eventUrl}`);
+    console.log(`eventTime = ${timeline}`);
+
+    // Return immediately if the issueNum is a Skills Issue- to discourage
+    // infinite loop (recording comment, recording the recording of comment, etc.)
+    const isSkillsIssue = await checkIfSkillsIssue(issueNum);
+    if (isSkillsIssue) {
+        console.log(`issueNum: ${issueNum} identified as Skills Issue`);
+        return activity;
+    }
+    // Return immediately if the eventActor is a bot- same reason
+    if (eventActor in excludedActors) {
+        return activity;
+    }
+
+    // Message templates to post on Skills Issue
+    const actionMap = {
+        'issues.opened': 'opened an issue',
+        'issues.completed': 'closed an issue as completed',
+        'issues.not_planned': 'closed an issue as not planned',
+        'issues.duplicate': 'closed an issue as duplicate',
+        'issues.assigned': 'been assigned to an issue',
+        'issues.unassigned': 'been unassigned from an issue',
+        'issue_comment.created': 'commented on an issue or pr',
+        'pull_request.opened': 'opened a pull request',
+        'pull_request.closed': 'had a pull request closed w/o merging',
+        'pull_request.merged': 'had a pull request merged',
+        'pull_request_review.submitted': 'submitted a pull request review'
+    };
+    const action = actionMap[`${eventName}.${eventAction}`];
+    let message = `@ ${eventActor} has ${action}: #[${issueNum}](${eventUrl}) at ${timeline}`;
+    console.log(message);
+
+    activity = [eventActor, message];
+    return activity;
+
+
+
+    /**
+     * Helper function to check if issueNum references a Skills Issue
+     * @param {Number} issueNum   - issue number to check 
+     * @returns {Boolean}         - true if Skills Issue, false if not
+     */
+    async function checkIfSkillsIssue(issueNum) {
+        // https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#list-labels-for-an-issue
+        const labelData = await github.request('GET /repos/{owner}/{repo}/issues/{issue_number}/labels', {
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: issueNum
+        });
+        const isSkillsIssue = labelData.data.some(label => label.name === "Complexity: Prework");
+
+        return isSkillsIssue;
+    }
+}
+
+module.exports = activityTrigger;

github-actions/activity-trigger/post-to-skills-issue.js

@@ -0,0 +1,85 @@
+// Import modules
+const retrieveSkillsIssue = require('../utils/retrieve-skills-issue');
+const postComment = require('../utils/post-issue-comment');
+const checkTeamMembership = require('../utils/check-team-membership');
+const statusFieldIds = require('../utils/_data/status-field-ids');
+const mutateIssueStatus = require('../utils/mutate-issue-status');
+
+
+
+/**
+ * Function to retrieve Skills Issue and post message
+ * @param {Object} github    - GitHub object 
+ * @param {Object} context   - Context object
+ * @param {Object} activity  - eventActor and message 
+ * 
+ */
+async function postToSkillsIssue({g, c}, activity) {
+
+    github = g;
+    context = c;
+
+    const owner = context.repo.owner;
+    const repo = context.repo.repo;
+    const TEAM = 'website-write';
+
+    const username = activity[0];
+    const message = activity[1];
+    const MARKER = '<!-- Skills Issue Activity Record -->';
+
+    // Retrieve user's Skills Issue
+    const { skillsIssueNum, skillsIssueNodeId } = await retrieveSkillsIssue(username);
+    // Return immediately if Skills Issue not found
+    if (skillsIssueNum) {
+        console.log(`Found Skills Issue for ${username}: ${skillsIssueNum}`);
+    } else {
+        console.log(`Did not find Skills Issue for ${username}. Cannot post message.`);
+        return;
+    }
+
+    // Retrieve all comments from the Skills Issue
+    // https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28#list-issue-comments
+    const commentData = await github.request('GET /repos/{owner}/{repo}/issues/{issueNum}/comments', {
+        owner,
+        repo,
+        issueNum: skillsIssueNum,
+    });
+
+    // Find the comment that includes the MARKER text and append message
+    const commentFound = commentData.data.find(comment => comment.body.includes(MARKER))
+    const commentFoundId = commentFound ? commentFound.id : null;
+
+    if (commentFound) {
+        const commentId = commentFoundId;
+        const originalBody = commentFound.body;
+        const updatedBody = `${originalBody}\n${message}`;
+        // https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28#update-an-issue-comment
+        const patchSkillsIssue = await github.request('PATCH /repos/{owner}/{repo}/issues/comments/{commentId}', {
+            owner,
+            repo,
+            commentId,
+            body: updatedBody
+        });
+    } else {
+        const body = `${MARKER}\n## Activity Log: ${username}\n${message}`;
+        await postComment(github, context, skillsIssueNum, body);
+    }
+
+    // Check whether eventActor is team member; if so open issue and move to "In progress"
+    const isActiveMember = await checkTeamMembership(github, username, team);
+
+    if (isActiveMember) {
+        // Make sure Skills Issue is open
+        await github.request('PATCH /repos/{owner}/{repo}/issues/{issueNum}', {
+            owner,
+            repo,
+            issueNum: skillsIssueNum,
+            state: "open",
+        });
+        // Update item's status to "In progress (actively working)"
+        let statusValue = statusFieldIds('In_Progress');
+        await mutateIssueStatus(github, context, skillsIssueNodeId, statusValue);
+    }
+}
+
+module.exports = postToSkillsIssue;

github-actions/utils/get-skills-issue.js

@@ -0,0 +1,29 @@
+/**
+ * Helper function to retrieve eventActor's Skills Issue
+ * @param {String} eventActor        - Key reference to look up user's Skill Issue
+ * @return {Object}                  - eventActor's skillsIssueNum and skillsIssueNodeId
+ */
+async function retrieveSkillsIssue(eventActor) {
+    // Note that this returns the first 10 issues assigned to the eventActor- which is presumed
+    // to include that person's Skills Issue- this might need to be changed if Skill's Issues not found 
+    // https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues
+    const issueData = await github.request('GET /repos/{owner}/{repo}/issues', {
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        assignee: eventActor,
+        state: 'all',
+        direction: 'asc',
+        per_page: 10,
+    });
+
+    // Find issue with the `Complexity: Prework` label, then extract skillsIssueNum and skillsIssueNodeId
+    const skillsIssue = issueData.data.find(issue => issue.labels.some(label => label.name === "Complexity: Prework"));
+    const skillsIssueNum = skillsIssue ? skillsIssue.number : null;
+    const skillsIssueNodeId = skillsIssue ? skillsIssue.node_id : null;
+
+    console.log(`Found skills issue ${skillsIssueNum}: ${skillsIssueNodeId}`);
+
+    return {skillsIssueNum, skillsIssueNodeId};
+}
+
+module.exports = retrieveSkillsIssue;