mirror of
https://gitea.com/gitea/tea.git
synced 2025-12-15 19:02:05 +01:00
feat: add repository webhook management (#798)
## Summary This PR adds support for organization-level and global webhooks in the tea CLI tool. ## Changes Made ### Organization Webhooks - Added `--org` flag to webhook commands to operate on organization-level webhooks - Implemented full CRUD operations for org webhooks (create, list, update, delete) - Extended TeaContext to support organization scope ### Global Webhooks - Added `--global` flag with placeholder implementation - Ready for when Gitea SDK adds global webhook API methods ### Technical Details - Updated context handling to support org/global scopes - Modified all webhook subcommands (create, list, update, delete) - Maintained backward compatibility for repository webhooks - Updated tests and documentation ## Usage Examples ```bash # Repository webhooks (existing) tea webhooks list tea webhooks create https://example.com/hook --events push # Organization webhooks (new) tea webhooks list --org myorg tea webhooks create https://example.com/hook --org myorg --events push,pull_request # Global webhooks (future) tea webhooks list --global ``` ## Testing - All existing tests pass - Updated test expectations for new descriptions - Manual testing of org webhook operations completed Closes: webhook management feature request Reviewed-on: https://gitea.com/gitea/tea/pulls/798 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Ross Golder <ross@golder.org> Co-committed-by: Ross Golder <ross@golder.org>
This commit is contained in:
143
cmd/webhooks/update.go
Normal file
143
cmd/webhooks/update.go
Normal file
@@ -0,0 +1,143 @@
|
||||
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package webhooks
|
||||
|
||||
import (
|
||||
stdctx "context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"code.gitea.io/tea/cmd/flags"
|
||||
"code.gitea.io/tea/modules/context"
|
||||
"code.gitea.io/tea/modules/utils"
|
||||
|
||||
"code.gitea.io/sdk/gitea"
|
||||
"github.com/urfave/cli/v3"
|
||||
)
|
||||
|
||||
// CmdWebhooksUpdate represents a sub command of webhooks to update webhook
|
||||
var CmdWebhooksUpdate = cli.Command{
|
||||
Name: "update",
|
||||
Aliases: []string{"edit", "u"},
|
||||
Usage: "Update a webhook",
|
||||
Description: "Update webhook configuration in repository, organization, or globally",
|
||||
ArgsUsage: "<webhook-id>",
|
||||
Action: runWebhooksUpdate,
|
||||
Flags: append([]cli.Flag{
|
||||
&cli.StringFlag{
|
||||
Name: "url",
|
||||
Usage: "webhook URL",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "secret",
|
||||
Usage: "webhook secret",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "events",
|
||||
Usage: "comma separated list of events",
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "active",
|
||||
Usage: "webhook is active",
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "inactive",
|
||||
Usage: "webhook is inactive",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "branch-filter",
|
||||
Usage: "branch filter for push events",
|
||||
},
|
||||
&cli.StringFlag{
|
||||
Name: "authorization-header",
|
||||
Usage: "authorization header",
|
||||
},
|
||||
}, flags.AllDefaultFlags...),
|
||||
}
|
||||
|
||||
func runWebhooksUpdate(ctx stdctx.Context, cmd *cli.Command) error {
|
||||
if cmd.Args().Len() == 0 {
|
||||
return fmt.Errorf("webhook ID is required")
|
||||
}
|
||||
|
||||
c := context.InitCommand(cmd)
|
||||
client := c.Login.Client()
|
||||
|
||||
webhookID, err := utils.ArgToIndex(cmd.Args().First())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Get current webhook to preserve existing settings
|
||||
var hook *gitea.Hook
|
||||
if c.IsGlobal {
|
||||
return fmt.Errorf("global webhooks not yet supported in this version")
|
||||
} else if len(c.Org) > 0 {
|
||||
hook, _, err = client.GetOrgHook(c.Org, int64(webhookID))
|
||||
} else {
|
||||
hook, _, err = client.GetRepoHook(c.Owner, c.Repo, int64(webhookID))
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Update configuration
|
||||
config := hook.Config
|
||||
if config == nil {
|
||||
config = make(map[string]string)
|
||||
}
|
||||
|
||||
if cmd.IsSet("url") {
|
||||
config["url"] = cmd.String("url")
|
||||
}
|
||||
if cmd.IsSet("secret") {
|
||||
config["secret"] = cmd.String("secret")
|
||||
}
|
||||
if cmd.IsSet("branch-filter") {
|
||||
config["branch_filter"] = cmd.String("branch-filter")
|
||||
}
|
||||
if cmd.IsSet("authorization-header") {
|
||||
config["authorization_header"] = cmd.String("authorization-header")
|
||||
}
|
||||
|
||||
// Update events if specified
|
||||
events := hook.Events
|
||||
if cmd.IsSet("events") {
|
||||
eventsList := strings.Split(cmd.String("events"), ",")
|
||||
events = make([]string, len(eventsList))
|
||||
for i, event := range eventsList {
|
||||
events[i] = strings.TrimSpace(event)
|
||||
}
|
||||
}
|
||||
|
||||
// Update active status
|
||||
active := hook.Active
|
||||
if cmd.IsSet("active") {
|
||||
active = cmd.Bool("active")
|
||||
} else if cmd.IsSet("inactive") {
|
||||
active = !cmd.Bool("inactive")
|
||||
}
|
||||
|
||||
if c.IsGlobal {
|
||||
return fmt.Errorf("global webhooks not yet supported in this version")
|
||||
} else if len(c.Org) > 0 {
|
||||
_, err = client.EditOrgHook(c.Org, int64(webhookID), gitea.EditHookOption{
|
||||
Config: config,
|
||||
Events: events,
|
||||
Active: &active,
|
||||
})
|
||||
} else {
|
||||
_, err = client.EditRepoHook(c.Owner, c.Repo, int64(webhookID), gitea.EditHookOption{
|
||||
Config: config,
|
||||
Events: events,
|
||||
Active: &active,
|
||||
})
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Printf("Webhook %d updated successfully\n", webhookID)
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user