mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-22 06:04:40 +03:00
51735c415b
Closes #2797 I'm aware of https://github.com/go-gitea/gitea/pull/28163 exists, but since I had it laying around on my drive and collecting dust, I might as well open a PR for it if anyone wants the feature a bit sooner than waiting for upstream to release it or to be a forgejo "native" implementation. This PR Contains: - Support for the `workflow_dispatch` trigger - Inputs: boolean, string, number, choice Things still to be done: - [x] API Endpoint `/api/v1/<org>/<repo>/actions/workflows/<workflow id>/dispatches` - ~~Fixing some UI bugs I had no time figuring out, like why dropdown/choice inputs's menu's behave weirdly~~ Unrelated visual bug with dropdowns inside dropdowns - [x] Fix bug where opening the branch selection submits the form - [x] Limit on inputs to render/process Things not in this PR: - Inputs: environment (First need support for environments in forgejo) Things needed to test this: - A patch for https://code.forgejo.org/forgejo/runner to actually consider the inputs inside the workflow. ~~One possible patch can be seen here: https://code.forgejo.org/Mai-Lapyst/runner/src/branch/support-workflow-inputs~~ [PR](https://code.forgejo.org/forgejo/runner/pulls/199) ![image](/attachments/2db50c9e-898f-41cb-b698-43edeefd2573) ## Testing - Checkout PR - Setup new development runner with [this PR](https://code.forgejo.org/forgejo/runner/pulls/199) - Create a repo with a workflow (see below) - Go to the actions tab, select the workflow and see the notice as in the screenshot above - Use the button + dropdown to run the workflow - Try also running it via the api using the `` endpoint - ... - Profit! <details> <summary>Example workflow</summary> ```yaml 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 number1_default: description: 'Number w. default' default: '100' type: number number2: description: 'Number w/o. default' type: number string1_default: description: 'String w. default' default: 'Hello world' type: string string2: description: 'String w/o. default' required: true type: string jobs: test: runs-on: docker steps: - uses: actions/checkout@v3 - run: whoami - run: cat /etc/issue - run: uname -a - run: date - run: echo ${{ inputs.logLevel }} - run: echo ${{ inputs.tags }} - env: GITHUB_CONTEXT: ${{ toJson(github) }} run: echo "$GITHUB_CONTEXT" - run: echo "abc" ``` </details> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/3334 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org> Co-committed-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org>
133 lines
4.7 KiB
Go
133 lines
4.7 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package actions
|
|
|
|
import (
|
|
webhook_module "code.gitea.io/gitea/modules/webhook"
|
|
)
|
|
|
|
const (
|
|
GithubEventPullRequest = "pull_request"
|
|
GithubEventPullRequestTarget = "pull_request_target"
|
|
GithubEventPullRequestReviewComment = "pull_request_review_comment"
|
|
GithubEventPullRequestReview = "pull_request_review"
|
|
GithubEventRegistryPackage = "registry_package"
|
|
GithubEventCreate = "create"
|
|
GithubEventDelete = "delete"
|
|
GithubEventFork = "fork"
|
|
GithubEventPush = "push"
|
|
GithubEventIssues = "issues"
|
|
GithubEventIssueComment = "issue_comment"
|
|
GithubEventRelease = "release"
|
|
GithubEventPullRequestComment = "pull_request_comment"
|
|
GithubEventGollum = "gollum"
|
|
GithubEventSchedule = "schedule"
|
|
GithubEventWorkflowDispatch = "workflow_dispatch"
|
|
)
|
|
|
|
// IsDefaultBranchWorkflow returns true if the event only triggers workflows on the default branch
|
|
func IsDefaultBranchWorkflow(triggedEvent webhook_module.HookEventType) bool {
|
|
switch triggedEvent {
|
|
case webhook_module.HookEventDelete:
|
|
// GitHub "delete" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#delete
|
|
return true
|
|
case webhook_module.HookEventFork:
|
|
// GitHub "fork" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#fork
|
|
return true
|
|
case webhook_module.HookEventIssueComment:
|
|
// GitHub "issue_comment" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment
|
|
return true
|
|
case webhook_module.HookEventPullRequestComment:
|
|
// GitHub "pull_request_comment" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_comment-use-issue_comment
|
|
return true
|
|
case webhook_module.HookEventWiki:
|
|
// GitHub "gollum" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#gollum
|
|
return true
|
|
case webhook_module.HookEventSchedule:
|
|
// GitHub "schedule" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
|
|
return true
|
|
case webhook_module.HookEventWorkflowDispatch:
|
|
// GitHub "workflow_dispatch" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
|
|
return true
|
|
case webhook_module.HookEventIssues,
|
|
webhook_module.HookEventIssueAssign,
|
|
webhook_module.HookEventIssueLabel,
|
|
webhook_module.HookEventIssueMilestone:
|
|
// Github "issues" event
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
// canGithubEventMatch check if the input Github event can match any Gitea event.
|
|
func canGithubEventMatch(eventName string, triggedEvent webhook_module.HookEventType) bool {
|
|
switch eventName {
|
|
case GithubEventRegistryPackage:
|
|
return triggedEvent == webhook_module.HookEventPackage
|
|
|
|
// See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#gollum
|
|
case GithubEventGollum:
|
|
return triggedEvent == webhook_module.HookEventWiki
|
|
|
|
case GithubEventWorkflowDispatch:
|
|
return triggedEvent == webhook_module.HookEventWorkflowDispatch
|
|
|
|
case GithubEventIssues:
|
|
switch triggedEvent {
|
|
case webhook_module.HookEventIssues,
|
|
webhook_module.HookEventIssueAssign,
|
|
webhook_module.HookEventIssueLabel,
|
|
webhook_module.HookEventIssueMilestone:
|
|
return true
|
|
|
|
default:
|
|
return false
|
|
}
|
|
|
|
case GithubEventPullRequest, GithubEventPullRequestTarget:
|
|
switch triggedEvent {
|
|
case webhook_module.HookEventPullRequest,
|
|
webhook_module.HookEventPullRequestSync,
|
|
webhook_module.HookEventPullRequestAssign,
|
|
webhook_module.HookEventPullRequestLabel,
|
|
webhook_module.HookEventPullRequestReviewRequest,
|
|
webhook_module.HookEventPullRequestMilestone:
|
|
return true
|
|
|
|
default:
|
|
return false
|
|
}
|
|
|
|
case GithubEventPullRequestReview:
|
|
switch triggedEvent {
|
|
case webhook_module.HookEventPullRequestReviewApproved,
|
|
webhook_module.HookEventPullRequestReviewComment,
|
|
webhook_module.HookEventPullRequestReviewRejected:
|
|
return true
|
|
|
|
default:
|
|
return false
|
|
}
|
|
|
|
case GithubEventIssueComment:
|
|
// https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_comment-use-issue_comment
|
|
return triggedEvent == webhook_module.HookEventIssueComment ||
|
|
triggedEvent == webhook_module.HookEventPullRequestComment
|
|
|
|
case GithubEventSchedule:
|
|
return triggedEvent == webhook_module.HookEventSchedule
|
|
|
|
default:
|
|
return eventName == string(triggedEvent)
|
|
}
|
|
}
|