CODEWITHSUNDEEP
githubgithub-actions
Jorge Rodriguez RV
Jorge Rodriguez RV

Reputation: 71

Reuse Jobs in GitHub Actions Workflow

I’m migrating a pipeline from Circle CI to Github Actions and am finding it a bit weird that I can only run jobs once instead of creating a job, then calling it from the workflow section, making it possible to call a job multiple times without duplicating the commands/scripts in that job.

My pipeline pushes out code to three environments, then runs a lighthouse scan for each of them. In circle ci I have 1 job to push the code to my envs and 1 job to run lighthouse. Then from my workflow section, I just call the jobs 3 times, passing the env as a parameter. Am I missing something or is there no way to do this in github actions? Do I just have to write out my commands 3 times in each job?

Upvotes: 6

Views: 4916

Answers (3)

VonC
VonC

Reputation: 1323055

Reusable workflows can't call other reusable workflows.

Actually, they can, since Aug. 2022:

GitHub Actions: Improvements to reusable workflows

Reusable workflows can now be called from a matrix and other reusable workflows.

You can now nest up to 4 levels of reusable workflows giving you greater flexibility and better code reuse.

Calling a reusable workflow from a matrix allows you to create richer parameterized builds and deployments.

Learn more about nesting reusable workflows.

Learn more about using reusable workflows with the matrix strategy.

Upvotes: 1

Cardinal
Cardinal

Reputation: 2175

There are 3 main approaches for code reusing in GitHub Actions:

Reusing workflows

The obvious option is using the "Reusable workflows" feature that allows you to extract some steps into a separate "reusable" workflow and call this workflow as a job in other workflows.

Takeaways:

  • Reusable workflows can't call other reusable workflows.
  • The strategy property is not supported in any job that calls a reusable workflow.
  • Env variables and secrets are not inherited.
  • It's not convenient if you need to extract and reuse several steps inside one job.
  • Since it runs as a separate job, you have to use build artifacts to share files between a reusable workflow and your main workflow.
  • You can call a reusable workflow in synchronous or asynchronous manner (managing it by jobs ordering using needs keys).
  • A reusable workflow can define outputs that extract outputs/outcomes from executed steps. They can be easily used to pass data to the "main" workflow.

Dispatched workflows

Another possibility that GitHub gives us is workflow_dispatch event that can trigger a workflow run. Simply put, you can trigger a workflow manually or through GitHub API and provide its inputs.

There are actions available on the Marketplace which allow you to trigger a "dispatched" workflow as a step of "main" workflow.

Some of them also allow doing it in a synchronous manner (wait until dispatched workflow is finished). It is worth to say that this feature is implemented by polling statuses of repo workflows which is not very reliable, especially in a concurrent environment. Also, it is bounded by GitHub API usage limits and therefore has a delay in finding out a status of dispatched workflow.

Takeaways

  • You can have multiple nested calls, triggering a workflow from another triggered workflow. If done careless, can lead to an infinite loop.
  • You need a special token with "workflows" permission; your usual secrets.GITHUB_TOKEN doesn't allow you to dispatch a workflow.
  • You can trigger multiple dispatched workflows inside one job.
  • There is no easy way to get some data back from dispatched workflows to the main one.
  • Works better in "fire and forget" scenario. Waiting for a finish of dispatched workflow has some limitations.
  • You can observe dispatched workflows runs and cancel them manually.

Composite Actions

In this approach we extract steps to a distinct composite action, that can be located in the same or separate repository.

From your "main" workflow it looks like a usual action (a single step), but internally it consists of multiple steps each of which can call own actions.

Takeaways:

  • Supports nesting: each step of a composite action can use another composite action.
  • Bad visualisation of internal steps run: in the "main" workflow it's displayed as a usual step run. In raw logs you can find details of internal steps execution, but it doesn't look very friendly.
  • Shares environment variables with a parent job, but doesn't share secrets, which should be passed explicitly via inputs.
  • Supports inputs and outputs. Outputs are prepared from outputs/outcomes of internal steps and can be easily used to pass data from composite action to the "main" workflow.
  • A composite action runs inside the job of the "main" workflow. Since they share a common file system, there is no need to use build artifacts to transfer files from the composite action to the "main" workflow.
  • You can't use continue-on-error option inside a composite action.

Source: my "DRY: reusing code in GitHub Actions" article

Upvotes: 9

Mason Smith
Mason Smith

Reputation: 1

I'm currently in the exact same boat and just found an answer. You're looking for a Composite Action, as suggested in this answer.

Upvotes: 0

Related Questions