RFC: Centralized Reusable Workflows vs Starter Workflows

[dragonfleas]

RFC: Centralized Reusable Workflows vs Starter Workflows

Request for discussion

Problem

Currently, there is a folder for starter workflows called workflow-templates/, it appears to be a less than ideal user experience using these for job specific tasks for a specific repository, such as terraform-format.yml, or terraform-tests-go.yml. The "replace me" sections of each of these workflows basically operate as an input, which there are alternatives for.

Proposal

We propose moving all current starter GitHub action workflows to centralized reusable workflows, and moving forward, only use starter workflows for trigger specific multi workflow jobs. Such as pr.yml, commit.yml, cron.yml.

Benefits

• All service workflows will be able to be versioned using git refs inside of the relative calling workflow
• Easier to maintain and update if versioning and branches are supported
• Repositories across our organization are more consistent when adoption happens
• Prevents bad commit interface when launching starter workflows from the UI (in GitHub)

Implementation

• Move current starter workflows out of workflow-templates/ into .github/workflows
• Create starter workflows for the trigger workflow runs like pr.yml commit.yml, cron.yml, and terraform.yml (the latter being highest priority)
• Retire our current documentation under starter workflows, and utilize this new practice moving forward

Discussion

Please share your thoughts and feedback on this proposal. We welcome any suggestions or concerns you may have.