Refactor GHA check-label-preliminary-update
to use label-directory.json
#7533
Labels
Complexity: Large
Draft
Issue is still in the process of being created
Feature: Refactor GHA
Refactoring GitHub actions to fit latest architectural norms
role: back end/devOps
Tasks for back-end developers
size: 5pt
Can be done in 19-30 hours
Milestone
Overview
Currently, the GHA workflow 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 a general ID (i.e. 'labelId') so that different HfLA project groups will be able to use the GHA workflows without needing to match the label names used by the Website team.
Action Items
This issue involves specifically the
check-label-preliminary-update.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.Refer to check-label-preliminary-update.
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:
role: front end
role: back end/devOps
role: design
role: user research
Add to
// Import modules
:Add comment:
then for each label, consult label-directory.json and replace labelName with the labelId:
Search the code for instances of the original label name and substitute the defined above.
Search for all code comments referencing a specific label name and replace with a generalized description.
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
The text was updated successfully, but these errors were encountered: