website icon indicating copy to clipboard operation
website copied to clipboard

Epic: Create GitHub Action Wiki pages

Open ExperimentsInHonesty opened this issue 1 year ago • 1 comments

Dependency

  • [ ] #4819 ((this issue needs to be updated with a list of pages missing produced by this issue)

Overview

We need to make wiki pages for the GHAs that don't yet have them

Details

  • We need to ensure that every GitHub Action is documented in the wiki, and add sections to each wiki GHA page, that provide information about relevant issue labels as well as instructions on how to test the GHA.
  • Some workflows contain many GitHub actions

Create the following issues

Issue for new page "How to Test/Review GHA Issues"

  • [ ] Create a new wiki page to outline the process of testing GHAs and reviewing GHA Pull Requests.

Issues for missing GHA wiki pages:

  • [ ] create wiki page for the GHA: trigger-issue
  • [ ] create wiki page for the GHA: trigger-schedule
  • [ ] create wiki page for the GHA: utils
### Action Items
- [ ] Become familiar with [HfLA's GitHub Actions wiki page](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions) and [HfLA's GitHub Actions wiki page](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions) 
- [ ] Edit [HfLA's GitHub Actions wiki page](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions) adding a new summary to describe [REPLACE WITH GHA].  
- [ ] Create a new wiki page to document [REPLACE WITH GHA] following the template
- [ ] Place link to the new page on [HfLA's GitHub Actions wiki page](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions) 

### Resources/Instructions
- [Hack for LA's GitHub Actions](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions#github-actions-architecture)
- This epic is a result of ER #4728

Resources/Instructions

Workflow file list

ExperimentsInHonesty avatar Mar 01 '24 01:03 ExperimentsInHonesty

Need to determine which labels these new issues will have

ExperimentsInHonesty avatar Mar 01 '24 01:03 ExperimentsInHonesty

@roslynwythe There are two issues

  • This one #6403
  • and #6402

This one is supposed to be for creating any GHA pages in the WIKI that are missing them 6402 is supposed to be for adding the testing info, which is why it has this issue as a dependency. But instead they are almost identical. Please update both issues.

ExperimentsInHonesty avatar Apr 10 '24 01:04 ExperimentsInHonesty

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 :)

github-actions[bot] avatar Apr 10 '24 01:04 github-actions[bot]

@roslynwythe I was looking at the ready for prioritization issues and came across

  • https://github.com/hackforla/website/issues/6643 which instructs the assignee to
  • [ ] "Test Procedure" - Detail the process for testing the GHA in case there is a code change or a change in a dependent label, resource or package.

I didn't see any documentation for how to write tests or test procedures, or which GHAs have tests that the assignee can review as an example.

  • [ ] Do the GHAs already have tests or test procedures, and the person is just documenting them?
  • [ ] Or are they expected to write procedures that should be followed when a change is made to the GHA?

ExperimentsInHonesty avatar Apr 16 '24 16:04 ExperimentsInHonesty

@roslynwythe I was looking at the ready for prioritization issues and came across

  • [ ] "Test Procedure" - Detail the process for testing the GHA in case there is a code change or a change in a dependent label, resource or package.

I didn't see any documentation for how to write tests or test procedures, or which GHAs have tests that the assignee can review as an example.

  • [ ] Do the GHAs already have tests or test procedures, and the person is just documenting them?
  • [ ] Or are they expected to write procedures that should be followed when a change is made to the GHA?
  • The existing GHA wiki pages do not include testing guidance, but this completed issue #4856 for updating an existing GHA wiki page did have that requirement, and I think the resulting guidance is very useful; in fact I used it myself to review some PRs and I made a tiny improvement. If you approve, I will mention this issue as an example.

roslynwythe avatar Apr 21 '24 06:04 roslynwythe

@roslynwythe

  • I do approve and went ahead and revised the action item checkbox in https://github.com/hackforla/website/issues/6643 to say
  • [ ] "Test Procedure" - Detail the process for testing the GHA in case there is a code change or a change in a dependent label, resource or package. (see the Test Procedure example in this issue comment Update wiki page for GitHub Action: "add update label weekly" #4856 (comment))

I also put it in the prioritized backlog

ExperimentsInHonesty avatar Apr 24 '24 00:04 ExperimentsInHonesty