Disable automatic builds for Gitea YAML files

[f135ta]

Feature Description

Currently, if you upload a YAML file into the .gitea/workflows folder, it automatically starts a build on each commit.
It would be nice if there was a config option to prevent this from happening so that builds could be triggered manually via the UI or in code by the API.

I have forked the code and patched this method for now - but it would be nice to have the feature built in maybe?

Original File: /modules/actions/workflows.go

func DetectWorkflows(
	gitRepo *git.Repository,
	commit *git.Commit,
	triggedEvent webhook_module.HookEventType,
	payload api.Payloader,
	detectSchedule bool,
) ([]*DetectedWorkflow, []*DetectedWorkflow, error) {
	_, entries, err := ListWorkflows(commit)
	if err != nil {
		return nil, nil, err
	}

	workflows := make([]*DetectedWorkflow, 0, len(entries))
	schedules := make([]*DetectedWorkflow, 0, len(entries))
	for _, entry := range entries {
		content, err := GetContentFromEntry(entry)
		if err != nil {
			return nil, nil, err
		}

		// one workflow may have multiple events
		events, err := GetEventsFromContent(content)
		if err != nil {
			log.Warn("ignore invalid workflow %q: %v", entry.Name(), err)
			continue
		}

		for _, evt := range events {
			log.Trace("detect workflow %q for event %#v matching %q", entry.Name(), evt, triggedEvent)

			// preserve scheduled workflows if requested
			if evt.IsSchedule() {
				if detectSchedule {
					dwf := &DetectedWorkflow{
						EntryName:    entry.Name(),
						TriggerEvent: evt,
						Content:      content,
					}
					schedules = append(schedules, dwf)
				}
				continue
			}

			// only allow manual workflow_dispatch events
			if evt.Name == "workflow_dispatch" {
				dwf := &DetectedWorkflow{
					EntryName:    entry.Name(),
					TriggerEvent: evt,
					Content:      content,
				}
				workflows = append(workflows, dwf)
			}
		}
	}

	return workflows, schedules, nil
}

Screenshots

No response

[lunny]

There are two ways to address this issue, and you don’t need to modify the source code.
First, you can disable this YAML file.
Second, you can define an event workflow dispatch, which allows you to manually trigger the event from the UI.

[ChristopherHX]

You should edit your workflow like this

- on: push
+ on: workflow_dispatch

First, you can disable this YAML file

Context: this prevents manual trigger if added later, must be enabled if you want to use the Actions Page Run workflow.

[f135ta]

I know that i can edit the YAML file and disable it, but i want it system wide. Otherwise i have to edit every single yaml file across my 83 projects and remember to do it in future :-/

[silverwind]

Workflow run on yaml existance is how Actions work fundamentally. I guess one could add a default-off global option like actions.MANUAL_RUN_ONLY or something, but I don't think it'll be very popular.

[f135ta]

That's fair enough, it was just a suggestion :-)

[silverwind]

I do see some use thought: When you have a broken runner and want to temporarily prevent gitea from automatically scheduling any actions jobs. If there are available runners, it will schedule jobs and keep them in waiting state indefinitely until a runner becomes available.

What also may work in your case would be to temporarily remove all runners, which should effectively prevent any jobs from being scheduled.