Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent naming for GitHub Actions #853

Open
doshitan opened this issue Jan 24, 2025 · 0 comments
Open

Consistent naming for GitHub Actions #853

doshitan opened this issue Jan 24, 2025 · 0 comments
Labels
scope: ci/cd GitHub actions workflows

Comments

@doshitan
Copy link
Contributor

doshitan commented 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:

  • 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:

Location Header
The Actions tab Image
The commit page Image
Check list on a PR after merge Image

Summary

The GitHub Actions could use more consistent naming/organization. Potential options:

  1. Start with app name, e.g. "{{ app_name }} - CI Vulnerability Scans", "{{ app_name }} - Deploy"
  2. 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?
@doshitan doshitan changed the title Consistent naming for GitHub actions Consistent naming for GitHub Actions Jan 24, 2025
@doshitan doshitan added the scope: ci/cd GitHub actions workflows label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: ci/cd GitHub actions workflows
Projects
None yet
Development

No branches or pull requests

1 participant