feat!: rebuild tea on Cobra with explicit noun/verb commands (#1126)

- **switch tea to the Cobra command tree:** `internal/app` wires the packages from parts 1–4 into explicit noun/verb commands with `--repo`, `--json` / `--jq`, `--sudo` and `--debug`; `main.go` points at it. Build, release and docs tooling (`tools/cli-docs`, Makefile, goreleaser, snap, CI) and README / CONTRIBUTING are updated.
- **remove the urfave/cli command tree:** deletes `cmd/`, `modules/`, the old integration tests, contrib completion scripts and the generated `docs/CLI.md`, and drops their dependencies. This commit only deletes.

## Breaking changes

This is a breaking release. It requires Gitea 28 or newer; configuration moves to separate `config.yml` and `hosts.yml` files and requires fresh authentication, and command names, aliases, flags and output formats change. `docs/migration-1.0.md` maps every old command, flag and environment variable to its replacement.

## Issues

fixes #1118
fixes #1116
fixes #1115
fixes #1094
fixes #1091
fixes #1073
fixes #1052
fixes #1032
fixes #1023
fixes #966
fixes #908
fixes #833
fixes #831
fixes #817
fixes #804
fixes #779
fixes #770
fixes #737
fixes #697
fixes #726
fixes #677
fixes #672
fixes #633
fixes #632
fixes #560
fixes #556
fixes #523
fixes #516
fixes #510
fixes #504
fixes #500
fixes #482
fixes #406
fixes #403
fixes #373
fixes #351
fixes #344
fixes #326
fixes #325
fixes #323
fixes #246
fixes #240
fixes #232
fixes #197
fixes #172
fixes #141
fixes #69
fixes #1110
fixes #569
fixes #480
fixes #666
fixes #670
fixes #457
fixes #643
fixes #498
fixes #490
fixes #1069
fixes #834
fixes #602
fixes #328
fixes #417
fixes #571
fixes #1029
fixes #489
fixes #1050
fixes #162
fixes #430
fixes #1087
fixes #683

Reviewed-on: https://gitea.com/gitea/tea/pulls/1126
Reviewed-by: TheFox0x7 <95654+thefox0x7@noreply.gitea.com>
This commit is contained in:
bircni committed 2026-10-11 17:23:06 +00:00
1 parent 12e415a7a7
commit f02245449b
456 files changed
+18892 -34015

No files matched your search

-139
View File
@@ -1,139 +0,0 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package wiki
import (
stdctx "context"
"net/http"
"gitea.dev/sdk"
"gitea.dev/tea/cmd/flags"
teaContext "gitea.dev/tea/modules/context"
"gitea.dev/tea/modules/print"
"github.com/urfave/cli/v3"
)
var (
wikiFieldsFlag = flags.FieldsFlag(print.WikiPageFields, []string{"title", "author", "updated", "sha"})
wikiRevisionFieldsFlag = flags.FieldsFlag(print.WikiRevisionFields, []string{"sha", "author", "date", "message"})
)
// CmdWikiList represents the list subcommand for wiki pages.
var CmdWikiList = cli.Command{
Name: "list",
Aliases: []string{"ls"},
Usage: "List wiki pages of the repository",
Description: "List wiki pages of the repository",
ArgsUsage: " ",
Action: RunWikiList,
Flags: append([]cli.Flag{
wikiFieldsFlag,
&flags.PaginationPageFlag,
&flags.PaginationLimitFlag,
}, flags.AllDefaultFlags...),
}
// CmdWikiView represents the view subcommand for wiki pages.
var CmdWikiView = cli.Command{
Name: "view",
Usage: "View a wiki page",
Description: "View a wiki page",
ArgsUsage: "<page>",
Action: RunWikiView,
Flags: append([]cli.Flag{}, flags.AllDefaultFlags...),
}
// CmdWikiRevisions represents the revisions subcommand for wiki pages.
var CmdWikiRevisions = cli.Command{
Name: "revisions",
Aliases: []string{"history"},
Usage: "List revisions of a wiki page",
Description: "List revisions of a wiki page",
ArgsUsage: "<page>",
Action: RunWikiRevisions,
Flags: append([]cli.Flag{
wikiRevisionFieldsFlag,
&flags.PaginationPageFlag,
&flags.PaginationLimitFlag,
}, flags.AllDefaultFlags...),
}
type wikiReadClient interface {
ListPages(ctx stdctx.Context, owner, repo string, opt gitea.ListWikiPagesOptions) ([]*gitea.WikiPageMetaData, *gitea.Response, error)
GetPage(ctx stdctx.Context, owner, repo, pageName string) (*gitea.WikiPage, *gitea.Response, error)
GetPageRevisions(ctx stdctx.Context, owner, repo, pageName string, opt gitea.ListWikiPageRevisionsOptions) (*gitea.WikiCommitList, *gitea.Response, error)
}
// RunWikiList lists wiki pages.
func RunWikiList(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiContext(cmd)
if err != nil {
return err
}
fields, err := wikiFieldsFlag.GetValues(cmd)
if err != nil {
return err
}
return runWikiListWithClient(ctx, ctx.Login.Client().Wiki, fields)
}
// RunWikiView shows a wiki page.
func RunWikiView(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiContext(cmd)
if err != nil {
return err
}
return runWikiViewWithClient(ctx, cmd.Args().First(), ctx.Login.Client().Wiki)
}
// RunWikiRevisions lists revisions of a wiki page.
func RunWikiRevisions(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiContext(cmd)
if err != nil {
return err
}
fields, err := wikiRevisionFieldsFlag.GetValues(cmd)
if err != nil {
return err
}
return runWikiRevisionsWithClient(ctx, cmd.Args().First(), ctx.Login.Client().Wiki, fields)
}
func initWikiContext(cmd *cli.Command) (*teaContext.TeaContext, error) {
ctx, err := teaContext.InitCommand(cmd)
if err != nil {
return nil, err
}
if err := ctx.Ensure(teaContext.CtxRequirement{RemoteRepo: true}); err != nil {
return nil, err
}
return ctx, nil
}
func runWikiListWithClient(ctx *teaContext.TeaContext, client wikiReadClient, fields []string) error {
pages, resp, err := client.ListPages(stdctx.Background(), ctx.Owner, ctx.Repo, gitea.ListWikiPagesOptions{ListOptions: flags.GetListOptions(ctx.Command)})
if err != nil {
if resp != nil && resp.StatusCode == http.StatusNotFound {
return print.WikiPagesList(nil, ctx.Output, fields)
}
return err
}
return print.WikiPagesList(pages, ctx.Output, fields)
}
func runWikiViewWithClient(ctx *teaContext.TeaContext, pageName string, client wikiReadClient) error {
page, _, err := client.GetPage(stdctx.Background(), ctx.Owner, ctx.Repo, pageName)
if err != nil {
return err
}
return print.WikiPageDetails(page, ctx.Output)
}
func runWikiRevisionsWithClient(ctx *teaContext.TeaContext, pageName string, client wikiReadClient, fields []string) error {
revisions, _, err := client.GetPageRevisions(stdctx.Background(), ctx.Owner, ctx.Repo, pageName, gitea.ListWikiPageRevisionsOptions{Page: ctx.Int("page")})
if err != nil {
return err
}
return print.WikiRevisionsList(revisions.WikiCommits, ctx.Output, fields)
}
-133
View File
@@ -1,133 +0,0 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package wiki
import (
"bytes"
stdctx "context"
"errors"
"net/http"
"testing"
"gitea.dev/sdk"
"gitea.dev/tea/cmd/flags"
teaContext "gitea.dev/tea/modules/context"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/urfave/cli/v3"
)
type fakeWikiReadClient struct {
owner string
repo string
pageName string
listOpts gitea.ListWikiPagesOptions
revisionOpts gitea.ListWikiPageRevisionsOptions
pages []*gitea.WikiPageMetaData
page *gitea.WikiPage
revisions *gitea.WikiCommitList
listResp *gitea.Response
listErr error
}
func (f *fakeWikiReadClient) ListPages(_ stdctx.Context, owner, repo string, opt gitea.ListWikiPagesOptions) ([]*gitea.WikiPageMetaData, *gitea.Response, error) {
f.owner = owner
f.repo = repo
f.listOpts = opt
return f.pages, f.listResp, f.listErr
}
func (f *fakeWikiReadClient) GetPage(_ stdctx.Context, owner, repo, pageName string) (*gitea.WikiPage, *gitea.Response, error) {
f.owner = owner
f.repo = repo
f.pageName = pageName
return f.page, nil, nil
}
func (f *fakeWikiReadClient) GetPageRevisions(_ stdctx.Context, owner, repo, pageName string, opt gitea.ListWikiPageRevisionsOptions) (*gitea.WikiCommitList, *gitea.Response, error) {
f.owner = owner
f.repo = repo
f.pageName = pageName
f.revisionOpts = opt
return f.revisions, nil, nil
}
func newWikiTestContext(output string) *teaContext.TeaContext {
cmd := &cli.Command{
Flags: []cli.Flag{
&flags.PaginationPageFlag,
&flags.PaginationLimitFlag,
&flags.OutputFlag,
},
}
cmd.Writer = &bytes.Buffer{}
requireNoError := func(err error) {
if err != nil {
panic(err)
}
}
requireNoError(cmd.Set("output", output))
return &teaContext.TeaContext{
Command: cmd,
Owner: "octo",
Repo: "tea",
Output: output,
}
}
func TestRunWikiListWithClientUsesRepoAndPagination(t *testing.T) {
ctx := newWikiTestContext("json")
require.NoError(t, ctx.Set("page", "2"))
require.NoError(t, ctx.Set("limit", "5"))
client := &fakeWikiReadClient{
pages: []*gitea.WikiPageMetaData{{Title: "Home"}},
}
err := runWikiListWithClient(ctx, client, []string{"title"})
require.NoError(t, err)
assert.Equal(t, "octo", client.owner)
assert.Equal(t, "tea", client.repo)
assert.Equal(t, 2, client.listOpts.Page)
assert.Equal(t, 5, client.listOpts.PageSize)
}
func TestRunWikiListWithClientTreats404AsEmptyWiki(t *testing.T) {
ctx := newWikiTestContext("json")
client := &fakeWikiReadClient{
listResp: &gitea.Response{Response: &http.Response{StatusCode: http.StatusNotFound}},
listErr: errors.New("not found"),
}
err := runWikiListWithClient(ctx, client, []string{"title"})
require.NoError(t, err)
}
func TestRunWikiViewWithClientUsesRequestedPage(t *testing.T) {
ctx := newWikiTestContext("json")
client := &fakeWikiReadClient{
page: &gitea.WikiPage{Title: "Home", ContentBase64: "IyBIZWxsbw=="},
}
err := runWikiViewWithClient(ctx, "Home", client)
require.NoError(t, err)
assert.Equal(t, "octo", client.owner)
assert.Equal(t, "tea", client.repo)
assert.Equal(t, "Home", client.pageName)
}
func TestRunWikiRevisionsWithClientUsesRequestedPageAndPageFlag(t *testing.T) {
ctx := newWikiTestContext("json")
require.NoError(t, ctx.Set("page", "3"))
client := &fakeWikiReadClient{
revisions: &gitea.WikiCommitList{WikiCommits: []*gitea.WikiCommit{}},
}
err := runWikiRevisionsWithClient(ctx, "Home", client, []string{"sha"})
require.NoError(t, err)
assert.Equal(t, "octo", client.owner)
assert.Equal(t, "tea", client.repo)
assert.Equal(t, "Home", client.pageName)
assert.Equal(t, 3, client.revisionOpts.Page)
}
-170
View File
@@ -1,170 +0,0 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package wiki
import (
"encoding/base64"
"fmt"
stdctx "context"
"gitea.dev/sdk"
"gitea.dev/tea/cmd/flags"
teaContext "gitea.dev/tea/modules/context"
"gitea.dev/tea/modules/print"
"gitea.dev/tea/modules/task"
"github.com/urfave/cli/v3"
)
var wikiTitleFlag = &cli.StringFlag{
Name: "title",
Aliases: []string{"t"},
Usage: "wiki page title",
}
var wikiContentFlag = &cli.StringFlag{
Name: "content",
Aliases: []string{"c"},
Usage: "wiki page content",
}
var wikiMessageFlag = &cli.StringFlag{
Name: "message",
Aliases: []string{"m"},
Usage: "commit message for the wiki change",
}
var wikiDeleteConfirmFlag = &cli.BoolFlag{
Name: "confirm",
Aliases: []string{"y"},
Usage: "confirm deletion without prompting",
}
var wikiWriteFlags = append([]cli.Flag{wikiTitleFlag, wikiContentFlag, wikiMessageFlag}, flags.LoginRepoFlags...)
// CmdWikiCreate represents the create subcommand for wiki pages.
var CmdWikiCreate = cli.Command{
Name: "create",
Aliases: []string{"c"},
Usage: "Create a wiki page",
Description: "Create a wiki page",
ArgsUsage: " ",
Action: RunWikiCreate,
Flags: wikiWriteFlags,
}
// CmdWikiEdit represents the edit subcommand for wiki pages.
var CmdWikiEdit = cli.Command{
Name: "edit",
Aliases: []string{"e"},
Usage: "Edit a wiki page",
Description: "Edit a wiki page",
ArgsUsage: "<page>",
Action: RunWikiEdit,
Flags: wikiWriteFlags,
}
// CmdWikiDelete represents the delete subcommand for wiki pages.
var CmdWikiDelete = cli.Command{
Name: "delete",
Aliases: []string{"rm"},
Usage: "Delete a wiki page",
Description: "Delete a wiki page",
ArgsUsage: "<page>",
Action: RunWikiDelete,
Flags: append([]cli.Flag{wikiDeleteConfirmFlag}, flags.LoginRepoFlags...),
}
func getWikiCreateOptions(cmd *cli.Command) (gitea.CreateWikiPageOptions, error) {
return buildWikiWriteOptions(cmd.String("title"), cmd.String("content"), cmd.String("message"), true)
}
func getWikiEditOptions(cmd *cli.Command) (gitea.CreateWikiPageOptions, error) {
return buildWikiWriteOptions(cmd.String("title"), cmd.String("content"), cmd.String("message"), false)
}
func buildWikiWriteOptions(title, content, message string, titleRequired bool) (gitea.CreateWikiPageOptions, error) {
if content == "" {
return gitea.CreateWikiPageOptions{}, fmt.Errorf("content is required")
}
if titleRequired && title == "" {
return gitea.CreateWikiPageOptions{}, fmt.Errorf("title is required")
}
return gitea.CreateWikiPageOptions{
Title: title,
ContentBase64: base64.StdEncoding.EncodeToString([]byte(content)),
Message: message,
}, nil
}
// RunWikiCreate creates a wiki page.
func RunWikiCreate(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiWriteContext(cmd)
if err != nil {
return err
}
return runWikiCreateWithClient(ctx, ctx.Login.Client().Wiki, cmd)
}
// RunWikiEdit edits a wiki page.
func RunWikiEdit(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiWriteContext(cmd)
if err != nil {
return err
}
return runWikiEditWithClient(ctx, cmd.Args().First(), ctx.Login.Client().Wiki, cmd)
}
// RunWikiDelete deletes a wiki page.
func RunWikiDelete(_ stdctx.Context, cmd *cli.Command) error {
ctx, err := initWikiWriteContext(cmd)
if err != nil {
return err
}
return runWikiDeleteWithClient(ctx, cmd.Args().First(), ctx.Login.Client().Wiki, cmd.Bool("confirm"))
}
func runWikiCreateWithClient(ctx *teaContext.TeaContext, client task.WikiWriteClient, cmd *cli.Command) error {
opts, err := getWikiCreateOptions(cmd)
if err != nil {
return err
}
page, err := task.CreateWikiPage(ctx, client, opts)
if err != nil {
return err
}
return print.WikiPageDetails(page, ctx.Output)
}
func runWikiEditWithClient(ctx *teaContext.TeaContext, pageName string, client task.WikiWriteClient, cmd *cli.Command) error {
if pageName == "" {
return fmt.Errorf("page name is required")
}
opts, err := getWikiEditOptions(cmd)
if err != nil {
return err
}
if opts.Title == "" {
opts.Title = pageName
}
page, err := task.EditWikiPage(ctx, client, pageName, opts)
if err != nil {
return err
}
return print.WikiPageDetails(page, ctx.Output)
}
func runWikiDeleteWithClient(ctx *teaContext.TeaContext, pageName string, client task.WikiWriteClient, confirm bool) error {
if pageName == "" {
return fmt.Errorf("page name is required")
}
if !confirm {
return fmt.Errorf("deletion requires --confirm")
}
return task.DeleteWikiPage(ctx, client, pageName)
}
func initWikiWriteContext(cmd *cli.Command) (*teaContext.TeaContext, error) {
return initWikiContext(cmd)
}
-131
View File
@@ -1,131 +0,0 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package wiki
import (
stdctx "context"
"testing"
"gitea.dev/sdk"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/urfave/cli/v3"
)
type fakeWikiWriteClient struct {
owner string
repo string
pageName string
create gitea.CreateWikiPageOptions
edit gitea.CreateWikiPageOptions
created *gitea.WikiPage
edited *gitea.WikiPage
deleted bool
}
func (f *fakeWikiWriteClient) CreatePage(_ stdctx.Context, owner, repo string, opt gitea.CreateWikiPageOptions) (*gitea.WikiPage, *gitea.Response, error) {
f.owner = owner
f.repo = repo
f.create = opt
return f.created, nil, nil
}
func (f *fakeWikiWriteClient) EditPage(_ stdctx.Context, owner, repo, pageName string, opt gitea.CreateWikiPageOptions) (*gitea.WikiPage, *gitea.Response, error) {
f.owner = owner
f.repo = repo
f.pageName = pageName
f.edit = opt
return f.edited, nil, nil
}
func (f *fakeWikiWriteClient) DeletePage(_ stdctx.Context, owner, repo, pageName string) (*gitea.Response, error) {
f.owner = owner
f.repo = repo
f.pageName = pageName
f.deleted = true
return nil, nil
}
func TestGetWikiCreateOptionsRequiresTitle(t *testing.T) {
_, err := buildWikiWriteOptions("", "# Home", "", true)
require.Error(t, err)
assert.Contains(t, err.Error(), "title")
}
func TestGetWikiCreateOptionsEncodesContent(t *testing.T) {
opts, err := buildWikiWriteOptions("Home", "# Home", "create home", true)
require.NoError(t, err)
assert.Equal(t, "Home", opts.Title)
assert.Equal(t, "IyBIb21l", opts.ContentBase64)
assert.Equal(t, "create home", opts.Message)
}
func TestGetWikiEditOptionsAllowsEmptyTitleButRequiresContent(t *testing.T) {
_, err := buildWikiWriteOptions("", "", "edit home", false)
require.Error(t, err)
assert.Contains(t, err.Error(), "content")
opts, err := buildWikiWriteOptions("", "# Updated", "edit home", false)
require.NoError(t, err)
assert.Equal(t, "", opts.Title)
assert.Equal(t, "IyBVcGRhdGVk", opts.ContentBase64)
assert.Equal(t, "edit home", opts.Message)
}
func TestWikiWriteCommandsRegistered(t *testing.T) {
assert.Equal(t, "create", CmdWikiCreate.Name)
assert.Equal(t, "edit", CmdWikiEdit.Name)
assert.Equal(t, "delete", CmdWikiDelete.Name)
}
func TestRunWikiCreateWithClientUsesRepoAndOptions(t *testing.T) {
ctx := newWikiTestContext("json")
client := &fakeWikiWriteClient{created: &gitea.WikiPage{Title: "Home", ContentBase64: "IyBIb21l"}}
cmd := &cli.Command{Flags: []cli.Flag{wikiTitleFlag, wikiContentFlag, wikiMessageFlag}}
require.NoError(t, cmd.Set("title", "Home"))
require.NoError(t, cmd.Set("content", "# Home"))
require.NoError(t, cmd.Set("message", "create home"))
err := runWikiCreateWithClient(ctx, client, cmd)
require.NoError(t, err)
assert.Equal(t, "octo", client.owner)
assert.Equal(t, "tea", client.repo)
assert.Equal(t, "Home", client.create.Title)
assert.Equal(t, "IyBIb21l", client.create.ContentBase64)
assert.Equal(t, "create home", client.create.Message)
}
func TestRunWikiEditWithClientUsesPageAndOptions(t *testing.T) {
ctx := newWikiTestContext("json")
client := &fakeWikiWriteClient{edited: &gitea.WikiPage{Title: "Home", ContentBase64: "IyBVcGRhdGVk"}}
cmd := &cli.Command{Flags: []cli.Flag{wikiTitleFlag, wikiContentFlag, wikiMessageFlag}}
require.NoError(t, cmd.Set("content", "# Updated"))
require.NoError(t, cmd.Set("message", "edit home"))
err := runWikiEditWithClient(ctx, "Home", client, cmd)
require.NoError(t, err)
assert.Equal(t, "octo", client.owner)
assert.Equal(t, "tea", client.repo)
assert.Equal(t, "Home", client.pageName)
assert.Equal(t, "Home", client.edit.Title)
assert.Equal(t, "IyBVcGRhdGVk", client.edit.ContentBase64)
assert.Equal(t, "edit home", client.edit.Message)
}
func TestRunWikiDeleteWithClientRequiresConfirm(t *testing.T) {
ctx := newWikiTestContext("json")
client := &fakeWikiWriteClient{}
err := runWikiDeleteWithClient(ctx, "Home", client, false)
require.Error(t, err)
assert.Contains(t, err.Error(), "--confirm")
assert.False(t, client.deleted)
err = runWikiDeleteWithClient(ctx, "Home", client, true)
require.NoError(t, err)
assert.True(t, client.deleted)
assert.Equal(t, "Home", client.pageName)
}
var _ = gitea.CreateWikiPageOptions{}