Actions support workflow dispatch event

[pangliang]

fix #23668

My plan:

• In the actions.list method, if workflow is selected and IsAdmin, check whether the on event contains workflow_dispatch. If so, display a Run workflow button to allow the user to manually trigger the run.
• Providing a form that allows users to select target brach or tag, and these parameters can be configured in yaml
• Simple form validation, required input cannot be empty
• Add a route /actions/run, and an actions.Run method to handle
• Add WorkflowDispatchPayload struct to pass the Webhook event payload to the runner when triggered, this payload carries the inputs values and other fields, doc: workflow_dispatch payload

Other PRs

• the Workflow.WorkflowDispatchConfig() method still return non-nil when workflow_dispatch is not defined. I submitted a PR https://gitea.com/gitea/act/pulls/85 to fix it. Still waiting for them to process.

Behavior should be same with github, but may cause confusion. Here's a quick reminder.

• Doc Said: This event will only trigger a workflow run if the workflow file is on the default branch.
  • If the workflow yaml file only exists in a non-default branch, it cannot be triggered. (It will not even show up in the workflow list)
  • If the same workflow yaml file exists in each branch at the same time, the version of the default branch is used. Even if Use workflow from selects another branch

name: Docker Image CI

on:
  workflow_dispatch:
    inputs:
      logLevel:
        description: 'Log level'
        required: true
        default: 'warning'
        type: choice
        options:
        - info
        - warning
        - debug
      tags:
        description: 'Test scenario tags'
        required: false
        type: boolean
      boolean_default_true:
        description: 'Test scenario tags'
        required: true
        type: boolean
        default: true
      boolean_default_false:
        description: 'Test scenario tags'
        required: false
        type: boolean
        default: false
      environment:
        description: 'Environment to run tests against'
        type: environment
        required: true
        default: 'environment values'
      number_required_1:
        description: 'number '
        type: number
        required: true
        default: '100'
      number_required_2:
        description: 'number'
        type: number
        required: true
        default: '100'
      number_required_3:
        description: 'number'
        type: number
        required: true
        default: '100'
      number_1:
        description: 'number'
        type: number
        required: false
      number_2:
        description: 'number'
        type: number
        required: false
      number_3:
        description: 'number'
        type: number
        required: false

env:
  inputs_logLevel:              ${{ inputs.logLevel }}
  inputs_tags:                  ${{ inputs.tags }}
  inputs_boolean_default_true:  ${{ inputs.boolean_default_true }}
  inputs_boolean_default_false: ${{ inputs.boolean_default_false }}
  inputs_environment:           ${{ inputs.environment }}
  inputs_number_1:              ${{ inputs.number_1  }}
  inputs_number_2:              ${{ inputs.number_2  }}
  inputs_number_3:              ${{ inputs.number_3  }}
  inputs_number_required_1:     ${{ inputs.number_required_1  }}
  inputs_number_required_2:     ${{ inputs.number_required_2  }}
  inputs_number_required_3:     ${{ inputs.number_required_3  }}

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: ls -la
      - run: env | grep inputs
      - run: echo ${{ inputs.logLevel }}
      - run: echo ${{ inputs.boolean_default_false }}

[wizpresso-steve-cy-fan]

Well, the problem is, you can specify some user-supplied fields for workflow_dispatch, have you handled that case as well?

[pangliang]

Well, the problem is, you can specify some user-supplied fields for workflow_dispatch, have you handled that case as well?

I plan to implement a version similar to github, providing a form that allows users to fill in the env parameters of the workflow run, and these parameters can be configured in yaml. Hopefully I can complete it

[yp05327]

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch

Should we also follow this note?

[yp05327]

In the actions.list method, if workflow is selected and IsAdmin, check whether the on event contains workflow_dispatch. If so, display a Run workflow button to allow the user to manually trigger the run.

IMO, this notification takes too many spaces, and we don't need to always display it at there?
How about put it into the dropdown menu?

Not a block, feel free to discus.

[pangliang]

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch Should we also follow this note?

I think it should be following now.

• When list workflow, DefaultBranch is used
• When running workflow_dispatch workflow, the target ref is selected and specified, but the workflow configuration still uses DefaultBranch

[pangliang]

In the actions.list method, if workflow is selected and IsAdmin, check whether the on event contains workflow_dispatch. If so, display a Run workflow button to allow the user to manually trigger the run.

IMO, this notification takes too many spaces, and we don't need to always display it at there? How about put it into the dropdown menu?

Not a block, feel free to discus.

At first I also tried to put it in the dropdown menu, but there was a confusing problem. When no child elements exist, the dropdown menu will not hide automatically. Then it is more difficult to deal with when to display the button

if a or b or c or .... then
   <dropdown>
          if a then
              <menu a>
          end
          if b then
              <menu b>
          end
          ...
   </dropdown>
end

I don't know, I feel a little OCD here

Maybe I'm using it the wrong way, so I copied the design from github
If you have a good solution please tell me, Or I can put it in dropdown. After all, there are only two if conditions now.

[yp05327]

It is a required input, but it is empty.

[yp05327]

• environment: gitea doesn't support the environment feature yet, right? Maybe act_runner uses environment as a keyword, so it can't get the value of inputs.environment

gitea doesn't support the environment feature yet, right? Maybe act_runner uses environment as a keyword, so it can't get the value of inputs.environment

If I set a default value, it works. Maybe it is caused by something else.

And if I change the default value, it will still be the default value.
So it seems that it will only display the default value, but not the value in the form.

[yp05327]

Suggested change

	{{if .AllowTriggerWorkflowDispatchEvent}}
	{{if .WorkflowDispatchConfig}}

AllowTriggerWorkflowDispatchEvent is unnecessary.
But WorkflowDispatch or WorkflowDispatchConfig should be improved,
return WorkflowDispatch{} when inputs are not defined.
return nil, when there are no workflow_dispatch in on

[pangliang]

AllowTriggerWorkflowDispatchEvent is used to decide whether to display trigger button, and WorkflowDispatchConfig is used to decide whether to process inputs;
it can also be triggered without inputs.

[yp05327]

When workflow_dispatch is defined, but inputs are not
→ workflowDispatchConfig = {}
→ workflowDispatchConfig != nil, let's display the notification
→ user click Run Workflow
→ workflowDispatchConfig.Inputs = nil, don't have inputs, don't show them

When workflow_dispatch and inputs are both defined
→ workflowDispatchConfig = nil
→ don't display the notification

But we should do some changes to WorkflowDispatchConfig function.
WorkflowDispatchConfig will return nil when workflow_dispatch is defined, but inputs are not.
And this also causes a bug now, when workflow_dispatch is defined, but inputs are not, the notification will not display😕

e.g.

nothing happened here:

[pangliang]

Yes, yes, you are right; before, WorkflowDispatchConfig() always returned non-null, but now the behavior of parse has been modified. Use workflowDispatchConfig to determine whether to display the button or not.

[pangliang]

Sorry for such a confusing scenario; I fixed it and the logic now is:

• workflow_dispatch is not defined, WorkflowDispatchConfig() return nil
• workflow_dispatch is defined WorkflowDispatchConfig() return non nil , Whether the input is defined or not
• inputs is not defined WorkflowDispatch.Inputs is nil

so,

• WorkflowDispatchConfig if exists, display button
• When .WorkflowDispatchConfig.Inputs is nil, <range > nothing happens

[pangliang]

ParseRawOn is no longer needed
but, I think some modif still need to be made, workflow_dispatch is not defined, WorkflowDispatchConfig() return nil

var config WorkflowDispatch
node := val["workflow_dispatch"]
if !decodeNode(node, &config) {
    return nil
}

return &config

change to

var config WorkflowDispatch
node, found := val["workflow_dispatch"]
if found && decodeNode(node, &config) {
    return &config
}

return nil

I submitted a simpler PR to fix it: https://gitea.com/gitea/act/pulls/85
The previous PR 84 is no longer needed

[yp05327]

Thanks for your contribution.

ps: not only workflow_dispatch, other events, e.g. workflow_call, have some similar functions,
we can check them later.

[yp05327]

We need do more changes in WorkflowDispatchConfig.

if w.RawOn.Kind != yaml.MappingNode {
		return nil
}

This is not correct. e.g. if I define this:

on: [push, workflow_dispatch]

w.RawOn.Kind is yaml.SequenceNode, and will return nil.
If I define this:

on: workflow_dispatch

w.RawOn.Kind is yaml.ScalarNode, and will return nil.

[pangliang]

Okay, I think I will have some time to work on it next few days; btw, it seems that the On function has the same problem, switch does not handle all types of kind.

[pangliang]

I pushed a new commit to nektos/act#2123 and added a recursive function to handle nested SequenceNode. It can also support workflow_call. The following cases have been tested.

on: workflow_dispatch

on: [push, workflow_dispatch]

on:
    - push
    - workflow_dispatch

on:
    push:
    pull_request:
    workflow_dispatch:
        inputs:
            logLevel:
                description: 'Log level'
                required: true
                default: 'warning'
                type: choice
                options:
                - info
                - warning
                - debug

[denyskon]

I changed it to checkbox because it is more common throughout Gitea UI

[denyskon]

Also, putting the titles of the input fields is equally common in Gitea UI. This long form is just an example and shouldn't normally contain so many fields. We can make it wider, however, just to look better.

[lunny]

Also, putting the titles of the input fields is equally common in Gitea UI. This long form is just an example and shouldn't normally contain so many fields. We can make it wider, however, just to look better.

Yes, wider is better.

[denyskon]

That would be tiny instead of mini. Looks better IMO, normal size would be too wide.

[denyskon]

(here with a more realistic example, taken from my production pipeline 😆 )

[yp05327]

Why removed ???

[techknowlogick]

Thanks so much @pangliang !!!

[lunny]

Please send a docs PR to https://gitea.com/gitea/docs

[FireGhost]

Why has this feature been removed from 1.22.2 in the end ?

[Janhouse]

@FireGhost this is part of 1.23, wait for release.