GitHub Actions: Rename "Update GitHub Data" to "Schedule Daily 1100" #2222
Labels
Complexity: Medium
Feature: Board/GitHub Maintenance
Project board maintenance that we have to do repeatedly
Feature: Refactor GHA
Refactoring GitHub actions to fit latest architectural norms
role: back end/devOps
Tasks for back-end developers
size: 1pt
Can be done in 4-6 hours
Status: Updated
No blockers and update is ready for review
Milestone
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 github-data.yml and rename the action to 'Schedule Daily 1100' so all scheduled actions that occur on 11am daily can live in this file.
Action Items
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:
- Schedule Friday 0700
- Schedule Thursday 1100
- Schedule Daily 1100
- Lint SCSS
- Add Linked Issue Labels to Pull Request
- Add Pull Request Instructions
- Add Missing Labels To Issues
- WR Add Linked Issue Labels to Pull Request
- WR Add Pull Request Instructions
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
The text was updated successfully, but these errors were encountered: