Refactor GHA: move formatComment function to github-actions/utils

[roslynwythe]

Dependencies

• Create Wiki page to fill in missing GHA documentation: Issue Trigger #5166

Overview

We need to move the function formatComment from github-actions\trigger-issue\add-missing-labels-to-issues\post-labels-comment.js to github-actions/utils in order to promote resuse of the function. In subsequent issues, other github actions scripts will reference formatComment from the new folder location.

Action Items

• move the declaration for the function function formatComment({ replacementString, placeholderString, filePathToFormat, textToFormat }) from the file github-actions\trigger-issue\add-missing-labels-to-issues\post-labels-comment.js to a new file github-actions/utils/format-comment.js. Also move the comment statements preceding the function declaration, that describe the function parameters, and move all of the statements comprising the function
• In github-actions\trigger-issue\add-missing-labels-to-issues\post-labels-comment.js, add a "require" statement to import the formatComment function from the new file. For a sample statement see github-actions/trigger-schedule/add-update-label-weekly/add-label.js
• Perform testing in your fork of the website repository to ensure that the functionality of "Add Missing Labels to Issues" is unchanged. Guidance on testing can be found in Hack for LA's GitHub Actions[^1] and in the comments of Create Wiki page to fill in missing GHA documentation: Issue Trigger #5166 (**FILL IN LINK TO COMMENT **)

Resources/Instructions

Hack for LA's GitHub Actions

[github-actions]

Hi @roslynwythe.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:
Complexity, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels

[github-actions]

Hi @Chrisklangley, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[Chrisklangley]

Availability: M-F 5:30-9pm
ETA : 12/15/23 EOD

[roslynwythe]

This issue is being closed because a larger issue exists that includes the consolidation of format-comment.js. See #3750