Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 1.57 KB

README.md

File metadata and controls

15 lines (8 loc) · 1.57 KB

Workflows

There are two types of workflows in this directory. GitHub doesn't support doesn't support sub folders and so they are all in one directory. Since we can't use folders, capital letters are used for the "Caller" workflows and lowercase for the "Job" workflows. This is just a convention to help keep track of what is what.

Callers

These are the high level workflows that can be associated with what triggers them. PRs, releases, merges, etc. These are typically associated with an action you will perform during the development process. These are made up of smaller jobs that are defined in the other workflows. These are the workflows that you will see in the Actions tab of the repo. By grouping these tasks into parent workflows, the jobs are grouped under one action in the actions tab. They share the smaller 'job' workflows so that they always run the same way.

Jobs

These are the smaller individual jobs that are used to build up the larger caller workflows. They can be thought of as running unit tests, building the binaries, or linting the code. When you open one of the parent caller actions in the actions tab, they will show these individual jobs.

Working with workflows

The easiest way to test a workflow is by modifying it on your forked repo. This way you have control over the settings and credentials and you can manipulate branches anyway you need to trigger the workflow. When testing this way, you should be careful that you are pushing to your repo and not the company's and also make sure to clean everything up in your repo once you have finished testing.