Show workflow_dispatch input parameters in UI

[ahvigil]

Select Topic Area

Product Feedback

Body

For workflows with a workflow_dispatch trigger that take inputs, it would be nice to be able to see the branch and input parameters that a workflow run was executed with. This was previously raised at https://github.com/orgs/community/discussions/8303 and the accepted answer there provides a workaround by putting params of interest into run-name for display in the action summary view, but this becomes cumbersome for workflows with more than a small number of relatively simple inputs that easily fit into a short text field.

Would be great if there was some way to inspect params for a particular workflow execution under https://github.com/<org>/<repo>/actions/runs/<run_id>/. Perhaps a panel under Run details?

[Wouter-Vugt-Shell]

It is a rather big gap for such a product to not be able to list which values are used to drive automation. Anybody working at any serious level with GHA will need this and that it is missing really stumps my brain. Is there effort underway to add this? Can I provide such effort myself?

Thanks!

[austinpray-mixpanel]

It's worth noting that jenkins has this capability

We have resorted to echoing out the important workflow dispatch parameters in each workflow. It's very tedious

[cellard0or]

Having the same problem. This needs to change, non-reproducible builds are a no-go.

[priley86]

Agreed. Very odd these are not yet visible in the UX.

[jeroenhabets]

W00t! Seems like a Table Stake and Quick Win combo to me!

Not just Jenkins but any build tool I know over the last 25 years has this info readily available as it's essential for build/deploy management, hence Table Stake.

Adding the info that triggered the job in the UI should be readily available and hence cannot be a major story, hence I assume this is a Quick Win.

This and more fine-grained UAC are the only key impediments for fully embracing GHA.

[LanderV-Vintecc]

I need this as well.

[deepbrook]

If this is implemend, please, please pleeeeeease also implement the option to declare a value as sensitive, so its value isnt leaked this way. thanks.

[austinpray-mixpanel]

Pretty sure this is covered by https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#masking-a-value-in-a-log

[deepbrook]

It isn't by default, if inputs are to be visible in the UI, I'd assume. Unless I misunderstand "UI" in the context of the posts above.

[ahvigil]

github already masks things in the env that seem like they could be sensitive when looking at task logs, so I assume they could use the same mechanism here. I agree that there needs to be a way to explicitly mask these too.

[nnellanspdl]

This seems like basic functionality. We'd like to see the input values that were used to run a particular instance of a workflow.

[klalumiere]

Something a bit more subtle: you can start the workflow with a step like

- name: Parameters
  env:
    PARAMETERS: "${{ tojson(inputs) }}"
  run: echo See env for the parameters

and then the parameters will be available in the logs. I use an environment variable because of this blog post.

[harsha549]

It doesn't make any sense as basic as this is ignored. I wish I could see an update about it.

[prabhatkgupta]

Yes this is highly needed. There is a genuine need & a lot of developers are asking for it. Can someone share an update?

[Mr-Saikiran]

It's been an year, and am still following this thread to check the updates..

Edit:

For my problem, I solved it with a workaround using choice type in inputs using workflow_dispatch.

This gives an UI to pass inputs but all the values should be added before in the options. Doesn't satisfy fully but atleast somewhat UI.

name: Config

on:
  workflow_dispatch:
    inputs:
      environment:
        type: choice
        required: true
        default: 'qa'
        options: 
          - qa
          - dev
      apihost:
        type: choice
        required: true
        default: 'fqdn-qa'
        options:
          - https://fqdn-qa
          - https://fqdn-dev

permissions:
    id-token: write
    contents: read
    packages: read

jobs:
  config:
    uses: org/config.yaml@v1
    secrets: inherit
    with:
      apihost: ${{ github.event.inputs.apihost }}

[fyelci]

I need this as well. It would be great to prioritise

[nghongphuong94]

Please add this feature. Even we can workaround by print the inputs out in one step, it's really painful that you can not see the params from the list of runs, but you have to click into one to check the params, then go back to the list if it's not the run you finding for 🤷‍♂️.

Such a very bad experience.

[shayki5]

Any news please? it's super basic feature...

[shayki5]

I've created a simple action which log the inputs to the UI and add them to the summary:
https://github.com/marketplace/actions/print-workflow-dispatch-inputs-and-env-vars

[jeroenhabets]

I've created a simple action which log the inputs to the UI and add them to the summary: https://github.com/marketplace/actions/print-workflow-dispatch-inputs-and-env-vars

Thank you @shayki5 for sharing yet another workaround but note as others have said many times before: this table stake should finally be readily supported by GitHub Actions @grandmas-favorite

[shayki5]

I've created a simple action which log the inputs to the UI and add them to the summary: https://github.com/marketplace/actions/print-workflow-dispatch-inputs-and-env-vars

Thank you @shayki5 for sharing yet another workaround but note as others have said many times before: this table stake should finally be readily supported by GitHub Actions @grandmas-favorite

I totally agree!