GitHub Actions: How to view inputs for workflow_dispatch?

user_16691876 0
Viewed 2865

My idea here is to write my inputs from workflow_dispatch on each pipeline run. ![enter image description here.

For example, in Bitbucket pipelines input parameters shown after custom - enter image description here

Is there a way to do something similar for GitHub?

cicd github-actions github
3 Answers

Although this does not directly answer your question, I'm adding it here because this is where I landed looking for the answer on how to output all my workflow inputs.

In my case I am using a workflow_dispatch trigger - YMMV if you are using a different trigger, but I suspect it would work the same way.

As with the other answer proposed, you will need to do this as a step within your job:

on:
  workflow_dispatch:
    inputs:
      myInput:
        default: "my input value"
jobs:
  myJob:
    steps:
      - name: Output Inputs
        run: echo "${{ toJSON(github.event.inputs) }}"

This will result in output you can view in your GitHub action execution output with the inputs serialized as JSON:

{
  "myInput": "my input value"
}
user_9471710

If you have only a few simple input values (from workflow_dispatch) then you can include them in the name of the job:

on:
  workflow_dispatch:
    inputs:
      my_value:
        description: 'My input value'
        required: true
        default: 'foo'
        type: string

jobs:
  my_job:
    name: "My job [my_value: ${{ github.event.inputs.my_value }}]"
    runs-on: ubuntu-latest

    steps:
    ....

This way you will be able to see the input directly in the GitHub UI.

user_60849480

You cannot really alter how they will be displayed on the list I'm afraid.

All you can do is to log your input variables inside action itself, like this:

jobs:
  debugInputs:
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo "Var1: ${{ github.event.inputs.var1 }}"
        echo "Var2: ${{ github.event.inputs.var2 }}"

If you want to see them in summary, you can use a notice or warning message mark:

user_20678770
Related