lab04.md

4 - Workflow Templates

In this lab you will reuse workflow templates.

Duration: 10-15 minutes

References:

• Reusing workflows
• Sharing workflows with your organization
• Sharing actions and workflows with your enterprise
• Using starter workflows

4.1 Create a reusable workflow

1. For a workflow to be reusable, the on must include the workflow_call event
2. Open the workflow file job-dependencies.yml
3. Edit the file and update the workflow to run on workflow call event

on:
  workflow_call:

4. Commit the changes into a new feature/lab04 branch
5. Go to Code and select the feature/lab04 from the branches drop down list
6. Open the workflow file reusable-workflow-template.yml
7. Edit the file and copy the following YAML content at the end of the file:

  call_dependencies_workflow_job:
    needs: call_reusable_workflow_job
    uses: <YOUR_USER_ACCOUNT>/gh-abcs-actions/.github/workflows/job-dependencies.yml@main

8. Update the workflow to run on push events

on:
  push:
     branches: [main]
  workflow_dispatch:    

9. Commit the changes into the same feature/lab04 branch
10. Open a new pull request from Pull requests

Make sure it is your repository pull request to not propose changes to the upstream repository. From the drop-down list choose the base repository to be yours.

11. Complete the pull request and delete the source branch
12. Go to Actions and see the details of your running workflow

4.2 Final

job-dependencies.yml

name: 02-2. Dependencies 

on:
  workflow_dispatch:
  push:
    branches:
      - main
  workflow_call:
    
jobs:
  initial:
    runs-on: ubuntu-latest
    steps:
      - run: echo "This job will be run first."
  fanout1:
    runs-on: ubuntu-latest
    needs: initial
    steps:
      - run: echo "This job will run after the initial job, in parallel with fanout2."
  fanout2:
    runs-on: ubuntu-latest
    needs: initial
    steps:
      - run: echo "This job will run after the initial job, in parallel with fanout1."
  fanout3:
    runs-on: ubuntu-latest
    needs: fanout1
    steps:
      - run: echo "This job will run after the initial job, in parallel with fanout2."
  fanin:
    runs-on: ubuntu-latest
    needs: [fanout1, fanout2]
    steps:
      - run: echo "This job will run after fanout1 and fanout2 have finished."
  build:
    runs-on: ubuntu-latest  
    strategy:
      matrix:
        configuration: [debug, release]
    steps:
    - run: echo "This job builds the cofiguration ${{ matrix.configuration }}."
  test:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - run: echo "This job will be run after the build job."
  ring01:
    runs-on: ubuntu-latest
    needs: test
    steps:
      - run: echo "This job will be run after the test job."
  ring02:
    runs-on: macos-latest
    needs: test
    steps:
      - run: echo "This job will be run after the test job."
  ring03:
    runs-on: ubuntu-latest
    needs: test
    steps:
      - run: echo "This job will be run after the test job."
  ring04:
    runs-on: ubuntu-latest
    needs: [ring01,ring02,ring03]
    steps:
      - run: echo "This job will be run after the ring01,ring02,ring03 jobs."
  prod:
    runs-on: ubuntu-latest
    needs: [ring04]
    steps:
      - run: echo "This job will be run after the ring04 job."

reusable-workflow-template.yml

name: 04-1. Call Reusable Workflow Templates

on:
  push:
     branches: [main]
  workflow_dispatch:    

jobs:
  call_greet_everyone_workflow_job:
    uses: githubabcs/gh-abcs-actions/.github/workflows/greet-everyone.yml@main
    with:
      name: 'Reusable Workflow Templates'
    
  call_reusable_workflow_job:
    uses: githubabcs/gh-abcs-actions/.github/workflows/super-linter.yml@main

  call_demo_workflow_job:
    needs: call_greet_everyone_workflow_job
    uses: githubabcs/gh-abcs-actions/.github/workflows/github-actions-demo.yml@main
  
  call_dependencies_workflow_job:
    needs: call_reusable_workflow_job
    uses: <YOUR_USER_ACCOUNT>/gh-abcs-actions/.github/workflows/job-dependencies.yml@main