You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are a number of GitHub Actions that can run at various times, some scoped to each application, some for the entire project, some that are not meant to be used directly, etc.
A sampling of display names for often running GH Actions:
CI <APP_NAME>
CI <APP_NAME> PR Environment Checks
CI <APP_NAME> PR Environment Destroy
CI Infra Service Checks - <APP_NAME>
CI Vulnerability Scans - <APP_NAME>
CI Documentation Checks
CI Infra Checks
Deploy <APP_NAME>
A visual example, in platform-test, with only two applications:
The GitHub Actions could use more consistent naming/organization. Potential options:
Start with app name, e.g. "{{ app_name }} - CI Vulnerability Scans", "{{ app_name }} - Deploy"
Start with "action", e.g. "CI Vulnerability Scans - {{ app_name }}", "Deploy - {{ app_name }}"
(any number of separators besides - could be chosen, obvious alts being : or /)
Also a lot of them start with "CI", which adds to the noise, though maybe worth while keeping?
And related-but-maybe-different question applies to the file names themselves, which currently grouped by ci or cd, then app name (e.g., cd-{{app_name}}, ci-{{app_name}}-vulnerability-scans) for app things. And no specific convention for workflows that are meant to be invoked by other ones (besides the convention of having no convention, i.e., just name them something reasonable after the function they perform).
This should also be applied to all the template-application-* repos.
Proposal
Pick a convention for naming actions that run against a particular application
Pick a convention for naming actions that run against the entire project/are not scoped to a particular application
Pick a convention for naming actions that are intended to primarily be reusable workflows/not used directly (and maybe one that alphabetically sorts them to the bottom?)
[Optional] Pick a convention for naming actions that are intended to be run manually by humans on occasion (like deploys?)
GitHub allows pinning of Actions to the top of the list on the project Actions page, so maybe we just provide a list of the Actions we suggest folks pin because they will be invoking them frequently?
The text was updated successfully, but these errors were encountered:
doshitan
changed the title
Consistent naming for GitHub actions
Consistent naming for GitHub Actions
Jan 24, 2025
Context
There are a number of GitHub Actions that can run at various times, some scoped to each application, some for the entire project, some that are not meant to be used directly, etc.
A sampling of display names for often running GH Actions:
A visual example, in
platform-test
, with only two applications:Summary
The GitHub Actions could use more consistent naming/organization. Potential options:
(any number of separators besides
-
could be chosen, obvious alts being:
or/
)Also a lot of them start with "CI", which adds to the noise, though maybe worth while keeping?
And related-but-maybe-different question applies to the file names themselves, which currently grouped by
ci
orcd
, then app name (e.g.,cd-{{app_name}}
,ci-{{app_name}}-vulnerability-scans
) for app things. And no specific convention for workflows that are meant to be invoked by other ones (besides the convention of having no convention, i.e., just name them something reasonable after the function they perform).This should also be applied to all the
template-application-*
repos.Proposal
The text was updated successfully, but these errors were encountered: