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

Introduce naming scheme for workflow names and workflow files #1066

Open
4 tasks
triffer opened this issue Oct 9, 2024 · 0 comments
Open
4 tasks

Introduce naming scheme for workflow names and workflow files #1066

triffer opened this issue Oct 9, 2024 · 0 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@triffer
Copy link
Collaborator

triffer commented Oct 9, 2024

Description
This issue should be blocked until #1068 is completed, since the outcome of issue #1068 will influence the work that needs to be done.

Introduce naming scheme for workflow names and workflow files in git to make obvious the responsibility of each workflow.
This should help with better understanding of the responsibility of the workflows and ordering of workflows in the Actions tab

There is a proposal for a naming scheme for the workflow names:

  • Main-PR for PR workflows to main branch
  • Main for workflows running on the main branch
  • Main-Scheduled for scheduled workflows running on main branch
  • Release-PR for PR workflows to release branch
  • Release for workflows running on the release branch workflows

For many workflows there is a on.workflow_call trigger. This was introduce to prevent silently failing of tests. Therefore we have many workflows that have the workflow_call trigger, but are only run in a specific scope, e.g. PR integration tests for release branches. Those workflows should also be scoped by the name.
To avoid confusion we should also add a prefix for those workflows, since they also show up in the Actions UI.

While creating the issue the main-integration workflow is special, because it runs on main and release branch. The current assumption is, that completing the issue to Improve test runs to avoid redundancy there might be different jobs running on main and release branch and two workflows exist.

Motivation

Fulfill AC Reduce job runs count, ensure all jobs have clear responsibility and meaning from our team goal.

ToDo [Developer]

  • ...

PRs

AC [PO]

  • Workflow names and file names adapted
  • Created follow up issue to adapt workflows in API Gateway

DoD [Developer & Reviewer]

  • Provide documentation.

Attachments

@triffer triffer added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

1 participant