Overwrite runs-on defined in workflow_call #26801

NissesSenap · 2021-10-13T11:16:37Z

NissesSenap
Oct 13, 2021

I’m creating a general workflow_call to create easy to use templates that is supposed to be used by both companies and open-source.
Some users will use self hosted servers and others will use “ubuntu-latest”

To my knowledge I have to define runs-on in my workflow_call action:

  <a href="https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#example-reusable-workflow" target="_blank" rel="noopener nofollow ugc">GitHub Docs</a>

Reusing workflows - GitHub Docs

Is there any way to overwrite runs-on so I instead can use
runs-on: [self-hosted, linux] where I want?

Answered by ChristopherHX

Oct 13, 2021

I didn’t think about this yet, it seems you can use expression syntax in runs-on with your input.

Example


on:
  workflow_call:
    inputs:
      runs-on:
        type: string
        default: '["windows-latest"]'
jobs:
  myjoba:
    runs-on: ${{fromJSON(inputs.runs-on)}}
    outputs:
      myout: myin
    steps:
    - run: echo Hello World

Call the workflow with runs-on as input.
Multiple labels

on: push
jobs:
  comp:
    name: comp-${{toJSON(strategy)}}
    uses: ChristopherHX/newcomposite-sample/.github/workflows/weirdworkflow.yml@reusable-workflows
    with:
      runs-on: '["self-hosted", "linux"]'

Single label

on: push
jobs:
  comp:
    uses: ChristopherHX/newcomposite-sample/.git…

View full answer

ChristopherHX · 2021-10-13T12:05:33Z

ChristopherHX
Oct 13, 2021

I didn’t think about this yet, it seems you can use expression syntax in runs-on with your input.

Example


on:
  workflow_call:
    inputs:
      runs-on:
        type: string
        default: '["windows-latest"]'
jobs:
  myjoba:
    runs-on: ${{fromJSON(inputs.runs-on)}}
    outputs:
      myout: myin
    steps:
    - run: echo Hello World

Call the workflow with runs-on as input.
Multiple labels

on: push
jobs:
  comp:
    name: comp-${{toJSON(strategy)}}
    uses: ChristopherHX/newcomposite-sample/.github/workflows/weirdworkflow.yml@reusable-workflows
    with:
      runs-on: '["self-hosted", "linux"]'

Single label

on: push
jobs:
  comp:
    uses: ChristopherHX/newcomposite-sample/.github/workflows/weirdworkflow.yml@reusable-workflows
    with:
      runs-on: '"windows-latest"'

It isn’t great that inputs cannot be Objects (Arrays), but only string, boolean or number. You have to use json, unless github allows object inputs in the furture.

I’m not shure where inputs are allowed and where it is forbidden, the documentation is outdated so I had to test it myself and it worked

0 replies

NissesSenap · 2021-10-13T12:13:32Z

NissesSenap
Oct 13, 2021
Author

Easier solution then I hoped for, I should have thought of it as well.
Thanks for the quick reply and the great example!

0 replies

jricciardi · 2021-10-13T15:47:33Z

jricciardi
Oct 13, 2021
Maintainer

Thanks for jumping in with that speedy reply, @ChristopherHX! Glad to hear this helped, @NissesSenap :slight_smile:

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

Overwrite runs-on defined in workflow_call #26801

{{title}}

Replies: 3 comments

{{title}}

{{title}}

{{title}}

Select a reply

GitHub Community

Overwrite runs-on defined in workflow_call #26801

NissesSenap Oct 13, 2021

Reusing workflows - GitHub Docs

Replies: 3 comments

ChristopherHX Oct 13, 2021

NissesSenap Oct 13, 2021 Author

jricciardi Oct 13, 2021 Maintainer

NissesSenap
Oct 13, 2021

ChristopherHX
Oct 13, 2021

NissesSenap
Oct 13, 2021
Author

jricciardi
Oct 13, 2021
Maintainer