Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor GHA add-label.js to use label-directory.json #7537

Open
7 tasks done
Tracked by #6454
t-will-gillis opened this issue Sep 28, 2024 · 1 comment · May be fixed by #7538
Open
7 tasks done
Tracked by #6454

Refactor GHA add-label.js to use label-directory.json #7537

t-will-gillis opened this issue Sep 28, 2024 · 1 comment · May be fixed by #7538
Assignees
Labels
Complexity: Large 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

Comments

@t-will-gillis
Copy link
Member

t-will-gillis commented Sep 28, 2024

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 the "Schedule Friday" 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 "Schedule Friday" GHA. Afterwards, create an additional branch for the edits following- this is the branch that will be attached to the PR.

Refer to add-label.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:
    • Status: Updated,
    • To Update !,
    • 2 weeks inactive.
  • Add to // Import modules:
    const retrieveLabelDirectory = require('../../utils/retrieve-label-directory');
    
  • Add comment:
    // Use labelIds to retrieve current labelNames from directory
    
    then for each label, consult label-directory.json and replace labelName with the labelId:
    const <labelId> = retrieveLabelDirectory('<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

@t-will-gillis t-will-gillis added 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 labels Sep 28, 2024
@t-will-gillis t-will-gillis added this to the 08. Team workflow milestone Sep 28, 2024
@t-will-gillis t-will-gillis self-assigned this Sep 28, 2024
@HackforLABot
Copy link
Contributor

Hi @t-will-gillis, 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 :)

@t-will-gillis t-will-gillis removed the Draft Issue is still in the process of being created label Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large 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
Projects
Status: New Issue Approval
Development

Successfully merging a pull request may close this issue.

2 participants