Overview

We want to enhance the GHA workflows to reference each label by a general ID (i.e. a 'labelKey') rather than the label's name so that other HfLA project groups can use these workflows without needing to match the label names used by the Website team.

Details

Currently, the GHA workflows files that add, remove, and change labels on issues identify each label by its name (i.e. the 'labelName') directly. Instead of hard-coding each label name, we want these files to identify each label by its 'labelKey' and use the retrieve-label-directory.js module to look up the corresponding 'labelName' that is needed in order for the REST API to apply labels to issues.

Action Items

This issue involves specifically the post-labels-comments.js function of the "Issue Trigger" GitHub Action, and you must set up your environment for testing GHAs in order to work on this issue. See notes below in "Resources/ Instructions", and ask questions if you need additional help- GHAs can be tricky, and if you get stuck somewhere, someone who has worked on these before might have information that will save you a lot of time.

• Before making any of the edits following, first create a test branch in your repo and demonstrate the current, correct behavior of the "Issue Trigger" GHA. Afterwards, create an additional branch for the edits following- this is the branch that will be attached to the PR.

Refer to post-labels-comments.js.

• A preliminary search found that this file uses the following labels. As you work through this issue, confirm that this list is correct, and note any additions or subtractions as needed:

  • size: missing
  • Feature Missing
  • Complexity: Missing
  • role missing

• Replace:

  var fs = require("fs");
  const postComment = require('../../utils/post-issue-comment');
  const formatComment = require('../../utils/format-comment');
  

  with:

  // Import modules
  var fs = require('fs');
  const postComment = require('../../utils/post-issue-comment');
  const formatComment = require('../../utils/format-comment');
  const retrieveLabelDirectory = require('../../utils/retrieve-label-directory');
  

• Replace the following:

  // Constant variables
  const LABELS_OBJ = {
    'Complexity: Missing': 'Complexity',
    'role missing': 'Role',
    'Feature Missing': 'Feature',
    'size: missing': 'Size'
  };
  

  with:

  // Label constants use labelKeys to retrieve current labelNames from directory
  const LABELS_OBJ = [
    sizeMissing,
    featureMissing,
    complexityMissing,
    roleMissing
  ] = [
    "sizeMissing",
    "featureMissing",
    "complexityMissing",
    "roleMissing"
  ].map(retrieveLabelDirectory);
  

• Search the code for instances of the original label name and substitute the defined above.

• Prior to submitting the PR, search for all code comment that reference a specific label name. If found:

  • List these instances out in a comment on this issue, with your suggestion for replacement text that generalizes it.
  • When finished, add the label ready for product and change status to "Questions / In Review"
  • Product will review and provide feedback on replacement text for revision or sign-off on changes.

• Perform a test in your own repo that demonstrates that there is no change to the GHA's functionality after making the edits.

Resources/Instructions

• Refer to Hack for LA's GitHub Actions (current revision), especially Tips 6, 7, and 8, if you have not already created you personal environment for testing.
• How to Test GitHub Actions
• Additional Notes for GitHub Actions
• This issue is part of the epic Epic: Enhancing GHA - JavaScript files to use common key: value JSON #6454