Update GHA wiki page with new section "How to review GHA Pull Requests"

[roslynwythe]

Overview

We need to add a section to the HfLA GitHub Actions wiki page to guide developers in the process of reviewing GitHub Action issues.

Action Items

• We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki
• Using the process outlined above, draft a new section of the Hack for LA's GitHub Actions page, titled "How to Review GitHub Actions Pull Requests". Include these subsections:
  • Creating a test branch on your fork
  • Modifying Repository Settings and Labels
  • Creating your own Project Board (link to Tip 6)
  • Using Personal Access Tokens to test in your own Project Board (link to Tip 7)

Resources/Instructions

Hack for LA's GitHub Actions
HfLA GitHub Actions - detail

[github-actions]

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

[nnr-nnr]

i. Availability: Sunday 9am–12pm PT, Monday 3pm–6pm PT
ii. ETA: Tues 8/1

[github-actions]

@nnr-nnr

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, August 1, 2023 at 12:05 AM PST.}

[nnr-nnr]

1. Progress: have familiarized self with pre-reads
2. Blockers: N/A
3. Availability: Sunday 8/6 11-1PM ET
4. ETA: Sunday 8/6
5. Pictures: N/A

[github-actions]

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

[pearlescence-m]

i. Availability: In the evenings & weekends
ii. ETA: 09/23/2023 at the latest

[pearlescence-m]

How to Review GitHub Actions Pull Requests

Step 1: Creating a test branch on your fork

1.1. Create a new branch for testing

First, make sure your gh-pages branch in your fork is synced to the original HfLA repository.

Then, create a new branch in your updated local repository where you will apply the changes from the pull request. You can name the branch something descriptive that includes the original branch name, for example:

git checkout -b test-gha-{INSERT_NAME_OF_BRANCH} gh-pages

1.2. Pull the suggested changes:

Get the changes from the pull request into your test branch. Replace {INSERT_NAME_OF_BRANCH} with the author's branch name you want to test:

git pull https://github.com/{INSERT_NAME_OF_OWNER}/website.git {INSERT_NAME_OF_BRANCH}

1.3 Push the test branch:

Once you apply any other the issue-specific edits in .yml files necessary to trigger the GitHub Actions, push the test branch with the applied changes to your forked repository on GitHub:

git push origin test-gha-{INSERT_NAME_OF_BRANCH}

Step 2: Modifying Repository Settings and Labels

In the "Settings" of your forked repository, make sure to change your "Default branch", and select the button with the arrows to switch you default branch to the newly created branch test-gha-{INSERT_NAME_OF_BRANCH} and update to it.

Important: when you are done testing make sure to repeat these steps to re-select "gh-pages" as your default branch.

Settings page of the repository.

There are also few other settings and configurations you may need to adjust depending on the action in review:

• Security policies
• Branch protection rules
• Issues
• Pull request (PR) templates
• Creating necessary labels

Modifying these settings will make sure that your forked repository is aligned with the hackforla/website repository and you can properly test the changes made by the GitHub Actions. You may need to consult with the HfLA-GitHub-Actions page, because understanding action can help decide what modifications will be needed to test it.

Step 3: Creating your own Project Board

Follow the steps to create your own Project Board copy for testing.

Step 4: Using Personal Access Tokens to test in your own Project Board

You will need to create your own Personal Access Tokens in your forked repository to ensure that the workflow can access it. It is also a best practice to give your secret an expiration date.

Important: when you are creating your own token, do not give your token the same name that you see in the yaml file, otherwise unexpected behavior may result. Any other name is OK (for example, TEST_TOKEN).

Monitor the workflow runs in the "Actions" tab of your forked repository to ensure that it works as expected.

[LRenDO]

Hi @pearlescence-m ! Great job with this issue! I'm assuming it's ready for review since you have completed all the steps. Adding the ready for dev lead label and adding it to the Questions / In Reveiew column as you did will notify us it's ready to be reviewed. If I got this wrong though, please let me know if there is something specific you would like help with.

• Formatting and wording aligns well with current Wiki Docs
• 4 topics on the issue are covered
• Descriptions are very clear
• Comment is linked in the How to Contribute to the Wiki page
• The issue was moved to the correct column for review

I have a couple relatively minor requests.

• Update the images. They are not working properly.
• This may be a little nit-picky but, in Step 2 change you might consider adjusting depending on the action in review: to something like you may need to adjust depending on the action in review: to make it sound less optional. Most actions require creating some kind of changes to one or more of these areas to effectively test them.
• Also in Step 2 adding something about how understanding the action can help decide what modifications will be needed to test a particular action and adding a link to the description of our GHAs

When you've made the changes you can ping me here in a comment and add the ready for dev lead label. Also, please let me know if you have any questions!

Thanks for working on this issue!

[pearlescence-m]

@LRenDO Yes, I did finish the issue at the time, but wasn't sure if I needed to use any label at all to indicate that since it wasn't mentioned in the issue -- thanks for clarifying this and for your feedback!

I made the changes concerning points 2 and 3. However, I am not sure how to add the images here. I added direct links to the images but they are still not displaying properly. Do you know if I need to upload them to the repo's assets folder (to use in relative paths)?

[LRenDO]

Hi @pearlescence-m! Thanks for making the updates! They look great!

It looks like the images not working because there needs to be a blank line before the images. Like this:

<summary>Settings page of the repository.</summary> 

![Image](https://github-production-user-asset-6210df.s3.amazonaws.com/20477610/270084494-9bd8ed9d-42f4-4f17-9c7e-1ce74202c003.png)

You can also replace the word image with alt text to describe the image.

Ping me when it's all set and I will go ahead and approve it!

[pearlescence-m]

@LRenDO thanks a lot, that worked! The issue is now ready for the review.

[LRenDO]

Hi @pearlescence-m! This looks great. Thanks for making the updates and contributing to the wiki! Nice work!