website
website copied to clipboard
GitHub Actions: Rename "Add Update Label to Issues Weekly" to "Schedule Friday 0700"
Overview
As a member of the backend team, github actions are much more maintainable and easier to understand if they are structured based on triggers and functionality. For this issue, we want to update add-update-label-weekly.yml and rename the action to 'Schedule Friday 0700' so all scheduled actions that occur on 7am every Friday can live in this file.
Action Items
- [x] Review the notes below to understand recent changes to our architecture
- [x] Rename the file from 'add-update-label-weekly.yml' to 'schedule-fri-0700.yml'
- [x] Rename the name of the action from 'Add Update Label to Issues Weekly' to 'Schedule Friday 0700'
- [x] The name of the job should still stay the same (line 8)
- [x] Update the location of the accompanying files
- [x] If not created yet, create a new directory under /github-actions/ called trigger-schedule
- [x] Move the add-update-label-weekly directory under /github-actions/trigger-schedule
- [x] Update the github action's js requirement to reflect the change in directory
- [ ] If possible, do a test on your local environment and make sure it still works
Resources/Instructions
Never done GitHub actions? Start here! add-update-label-weekly.yml GitHub Actions Workflow Directory Accompanying JS
Architecture Notes
The idea behind the refactor is to organize our GitHub Actions so that developers can easily maintain and understand them. Currently, we want our GitHub Actions to be structured like so based on this proposal:
- Schedules (military time) - Schedule Friday 0700 - Schedule Thursday 1100 - Schedule Daily 1100
- Linters - Lint SCSS
- PR Trigger - Add Linked Issue Labels to Pull Request - Add Pull Request Instructions
- Issue Trigger - Add Missing Labels To Issues
- WR - PR Trigger - WR Add Linked Issue Labels to Pull Request - WR Add Pull Request Instructions
- WR - Issue Trigger
Actions with the same triggers (excluding linters, which will be their own category) will live in the same github action file. Scheduled actions will live in the same file if they trigger on the same schedule (i.e. all files that trigger everyday at 11am will live in one file, while files that trigger on Friday at 7am will be on a separate file).
That said, this structure is not set in stone. If any part of it feels strange, or you have questions, feel free to bring it up with the team so we can evolve this format!
Additional resources:
Events that trigger workflows Workflow syntax for GitHub Actions actions/github-script GitHub RESTAPI GitHub GraphQL
Hi @macho-catt.
Good job adding the required labels to this issue.
Just a friendly reminder to also move the issue into the "New Issue Approval" column under the Project Board. For more info on that, check Github's documentation here. Thanks!
Additional Resources: Wiki: How to add status labels to issues (WIP. Link will be updated when the wiki is done) Wiki: How to create issues (WIP. Link will be updated when the wiki is done)
Hi @poorvi4, 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 :)
ETA: 3-5 hours Availability: Sunday-Tuesday 2 hours each day, 8-10 pm
- see issue #3426 for what prior work had been done and also checkout this google doc to see how to use Nekros
@hackforla/website-merge This was discussed at the last DEV/PM meeting, and it was decided that dev leads would look at this issue to see what next steps are with this issue.
I dont see any movement on this. Adding back to dev/pm agenda and moving to Question column
Adding a note in resources for the work that was done previously before it was abandoned. We are going to send this back to the prioritized backlog.
Availability: Wed, Thur, Fri, Sat 10 am - 5 pm CST / Week of 3/27/23 Week of 4/3/23 Mon,Wed,Fri, Sat 10 am - 5 pm CST ETA: End of next week. 4/7/23
Test on fork: https://github.com/jefflueck/website-1/actions/runs/4584213135/jobs/8095565715 All workflows showed complete