ER: Request for Update of Hack for LA's Current GHA's Documentation

[karengcecena]

Emergent Requirement - Problem

• The current Hack for LA's Current GHA's Documentation is missing a lot of the GHAs currently found in the website repository.
• I believe it would be beneficial to 1) organize the GHA to be in the same order as presented within the github-actions folder and also add the GHA that are missing.

This is the current structure of the GHA Documentation:

move-closed-issues

• sort-closed-issues.js

pr-instructions

• create-instructions.js
• post.comment.js

trigger-issue

• /add-missing-labels-to-issue
  • check-labels.js
  • post-labels-comment.js
• /add-preliminary-comment
  • check-label-preliminary-update.js
  • preliminary-update-comment.js

trigger-pr

• set-pr-labels.js

trigger-schedule

• /add-update-label-weekly
  • add-label.js
• /github-data
  • get-project-data.js
• /list-inactive-members
  • comment-issues.js
  • create-new-issue.js
  • get-list.js
• /trim-contributers
  • contributors-data.js

utils

• find-linked-issue.js
• obtain-labels.js

These are the current GitHub actions and what I think they correspond to:

add update label weekly

• add-label.js in trigger-schedule/add-update-label-weekly

github data

• get-project-data.js in trigger-schedule/github-data
• I really like how this one stated the js folder first thing in the summary

issue trigger

• uses obtain-labels.js in utils folder
• I think it is supposed to be about check-labels.js and post-labels-comment.js in trigger-issue/add-missing-labels-to-issue
  • I think the documentation could be a lot stronger/ more specific about each .js file

lint-scss

• it is part of .stylelintrc.json in https://github.com/hackforla/website/blob/gh-pages/.stylelintrc.json and is part of the lint-scss.yml file in workflow

move closed issues

• sort-closed-issues.js in move-closed-issues

pr instructions

• create-instructions.js and post.comment.js in pr-instructions

pull request trigger

• pull-request-trigger.yml in workflow

set pr labels

• set-pr-labels.yaml in workflow
• set-pr-labels.js in trigger-pr

update team members (NOT FOUND?)

• update-team-members.yml in workflow WHICH IS NOT FOUND
• https://github.com/hackforla/website/tree/gh-pages/github-actions/github-data WHICH IS NOT FOUND

vrms data

• vrms-data.yml in workflow
• https://github.com/hackforla/website/blob/gh-pages/_data/external/vrms_data.json

wr pr instructions

• wr-pr-instructions.yml in workflow

wr pull request trigger

• wr-pull-request-trigger.yml in workflow

wr set pr labels

• wr-set-pr-labels.yaml in workflow

Deprecated GHAs

no-labels-template.md

• in trigger-issue/add-missing-labels-to-issue

That leaves these within github-actions without any sort of documentation:

trigger-issue

• /add-preliminary-comment
  • check-label-preliminary-update.js
  • preliminary-update-comment.js

trigger-schedule

• /list-inactive-members
  • comment-issues.js
  • create-new-issue.js
  • get-list.js
• /trim-contributers
  • contributors-data.js

utils

• find-linked-issue.js

These are also In the Workflow Folder but not in the documentation:

• schedule-daily-1100.yml
• schedule-fri-0700.yml
• schedule-monthly.yml
• schedule-thu-1100.yml

Issue you discovered this emergent requirement in

• VS Code Spell Checker Extension: GHA Messaging #4469

Date discovered

• 04/20/2023

Did you have to do something temporarily

• YES
• NO

Who was involved

• n/a

What happens if this is not addressed

• A lot of time is wasted with missing issues on the documentation. I had to go to the website code specifically and search through each GHA to try and complete my issue. I feel like it would be more beneficial for everyone to have the documentation be up to date with some re-organization to make it easily understandable.

Resources

• n/a

Recommended Action Items

• Make a new issue
• Discuss with team
• Let a Team Lead know

Potential solutions [draft]

Create an issue that has someone:

1) Order the GHA Documentation - I think an order that would make sense could be something like:

/gitub-actions

• move closed issues
• pr instructions
• issue trigger (maybe rename to trigger-issue)
• set pr labels (maybe rename to trigger-pr)
• /trigger-schedule (create an umbrella title to put these two under based on their organization in the code)
  • add update label weekly
  • github data

/.github/workflows

• lint-scss
• pull request trigger
• vrms data
• wr pr instructions
• wr pull request trigger
• wr set pr labels
• update team members (NOT FOUND?)

2) Add the missing GHA:

trigger-issue

• /add-preliminary-comment
  • check-label-preliminary-update.js
  • preliminary-update-comment.js

trigger-schedule

• /list-inactive-members
  • comment-issues.js
  • create-new-issue.js
  • get-list.js
• /trim-contributers
  • contributors-data.js

utils

• find-linked-issue.js

3) Add the missing workflows:

• schedule-daily-1100.yml
• schedule-fri-0700.yml
• schedule-monthly.yml
• schedule-thu-1100.yml

[github-actions]

Hi @roslynwythe, 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 :)

[roslynwythe]

• Created epic Epic: Update GitHub Action Wiki pages' spreadsheet #4819

[roslynwythe]

• see Epic: Update GitHub Action Wiki pages' spreadsheet #4819