forgejo/modules/actions/github.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"
)

// 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.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 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

	default:
		return eventName == string(triggedEvent)
	}
}