mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-10-30 22:11:07 +00:00 
			
		
		
		
	urfave/cli v2 will eventually become unmaintained, switch over to v3 which is the latest supported version. Note: the `docs` command would be a lot of work to restore with v3 ([the package is still in alpha](https://github.com/urfave/cli-docs)) An alternative to avoid a breaking change would be to not upgrade from v2 to v3 for that reason alone. Note: these commits were cherry-picked from https://code.forgejo.org/forgefriends/forgefriends Note: it is best reviewed side by side with no display of whitespace changes (there are a lot of those when converting vars to func). - a few functional changes were necessary and are noted in context in the file changes tab - https://cli.urfave.org/migrate-v2-to-v3/ upgrade instructions were followed in the most minimal way possible - upgrade gof3 to v3.10.8 which includes and upgrade from urfave/cli v2 to urfave/cli v3 - upgrade gitlab.com/gitlab-org/api/client-go v0.129.0 because it is an indirect dependency of gof3 and requires a change because of a deprecated field that otherwise triggers a lint error but nothing else otherwise - verified that the [script](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) that generates the [CLI documentation](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) still works. There are cosmetic differences and the **help** subcommand is no longer advertised (although it is still supported) but the `--help` option is advertised as expected so it is fine. - end-to-end tests [passed](https://code.forgejo.org/forgejo/end-to-end/pulls/667) (they use the Forgejo CLI to some extent) ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [x] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Breaking features - [PR](https://codeberg.org/forgejo/forgejo/pulls/8035): <!--number 8035 --><!--line 0 --><!--description VGhlIGBmb3JnZWpvIGRvY3NgIGNvbW1hbmQgaXMgZGVwcmVjYXRlZCBhbmQgQ0xJIGVycm9ycyBhcmUgbm93IGRpc3BsYXllZCBvbiBzdGRlcnIgaW5zdGVhZCBvZiBzdGRvdXQuIFRoZXNlIGJyZWFraW5nIGNoYW5nZXMgaGFwcGVuZWQgYmVjYXVzZSB0aGUgcGFja2FnZSB1c2VkIHRvIHBhcnNlIHRoZSBjb21tYW5kIGxpbmUgYXJndW1lbnRzIHdhcyBbdXBncmFkZWQgZnJvbSB2MiB0byB2M10oaHR0cHM6Ly9jbGkudXJmYXZlLm9yZy9taWdyYXRlLXYyLXRvLXYzLykuIEEgW3NlcGFyYXRlIHByb2plY3Qgd2FzIGluaXRpYXRlZF0oaHR0cHM6Ly9naXRodWIuY29tL3VyZmF2ZS9jbGktZG9jcykgdG8gcmUtaW1wbGVtZW50IHRoZSBgZG9jc2AgY29tbWFuZCwgYnV0IGl0IGlzIG5vdCB5ZXQgcHJvZHVjdGlvbiByZWFkeS4=-->The `forgejo docs` command is deprecated and CLI errors are now displayed on stderr instead of stdout. These breaking changes happened because the package used to parse the command line arguments was [upgraded from v2 to v3](https://cli.urfave.org/migrate-v2-to-v3/). A [separate project was initiated](https://github.com/urfave/cli-docs) to re-implement the `docs` command, but it is not yet production ready.<!--description--> <!--end release-notes-assistant--> Co-authored-by: limiting-factor <limiting-factor@posteo.com> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8035 Reviewed-by: Gusted <gusted@noreply.codeberg.org>
		
			
				
	
	
		
			178 lines
		
	
	
	
		
			4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			178 lines
		
	
	
	
		
			4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2016 The Gogs Authors. All rights reserved.
 | |
| // Copyright 2016 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package cmd
 | |
| 
 | |
| import (
 | |
| 	"context"
 | |
| 	"fmt"
 | |
| 
 | |
| 	"forgejo.org/models/db"
 | |
| 	repo_model "forgejo.org/models/repo"
 | |
| 	"forgejo.org/modules/git"
 | |
| 	"forgejo.org/modules/gitrepo"
 | |
| 	"forgejo.org/modules/log"
 | |
| 	repo_module "forgejo.org/modules/repository"
 | |
| 
 | |
| 	"github.com/urfave/cli/v3"
 | |
| )
 | |
| 
 | |
| // CmdAdmin represents the available admin sub-command.
 | |
| func cmdAdmin() *cli.Command {
 | |
| 	return &cli.Command{
 | |
| 		Name:  "admin",
 | |
| 		Usage: "Perform common administrative operations",
 | |
| 		Commands: []*cli.Command{
 | |
| 			subcmdUser(),
 | |
| 			subcmdRepoSyncReleases(),
 | |
| 			subcmdRegenerate(),
 | |
| 			subcmdAuth(),
 | |
| 			subcmdSendMail(),
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func subcmdRepoSyncReleases() *cli.Command {
 | |
| 	return &cli.Command{
 | |
| 		Name:   "repo-sync-releases",
 | |
| 		Usage:  "Synchronize repository releases with tags",
 | |
| 		Action: runRepoSyncReleases,
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func subcmdRegenerate() *cli.Command {
 | |
| 	return &cli.Command{
 | |
| 		Name:  "regenerate",
 | |
| 		Usage: "Regenerate specific files",
 | |
| 		Commands: []*cli.Command{
 | |
| 			microcmdRegenHooks,
 | |
| 			microcmdRegenKeys,
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func subcmdAuth() *cli.Command {
 | |
| 	return &cli.Command{
 | |
| 		Name:  "auth",
 | |
| 		Usage: "Modify external auth providers",
 | |
| 		Commands: []*cli.Command{
 | |
| 			microcmdAuthAddOauth(),
 | |
| 			microcmdAuthUpdateOauth(),
 | |
| 			microcmdAuthAddLdapBindDn(),
 | |
| 			microcmdAuthUpdateLdapBindDn(),
 | |
| 			microcmdAuthAddLdapSimpleAuth(),
 | |
| 			microcmdAuthUpdateLdapSimpleAuth(),
 | |
| 			microcmdAuthAddSMTP(),
 | |
| 			microcmdAuthUpdateSMTP(),
 | |
| 			microcmdAuthList(),
 | |
| 			microcmdAuthDelete(),
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func subcmdSendMail() *cli.Command {
 | |
| 	return &cli.Command{
 | |
| 		Name:   "sendmail",
 | |
| 		Usage:  "Send a message to all users",
 | |
| 		Action: runSendMail,
 | |
| 		Flags: []cli.Flag{
 | |
| 			&cli.StringFlag{
 | |
| 				Name:  "title",
 | |
| 				Usage: `a title of a message`,
 | |
| 				Value: "",
 | |
| 			},
 | |
| 			&cli.StringFlag{
 | |
| 				Name:  "content",
 | |
| 				Usage: "a content of a message",
 | |
| 				Value: "",
 | |
| 			},
 | |
| 			&cli.BoolFlag{
 | |
| 				Name:    "force",
 | |
| 				Aliases: []string{"f"},
 | |
| 				Usage:   "A flag to bypass a confirmation step",
 | |
| 			},
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func idFlag() *cli.Int64Flag {
 | |
| 	return &cli.Int64Flag{
 | |
| 		Name:  "id",
 | |
| 		Usage: "ID of authentication source",
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func runRepoSyncReleases(ctx context.Context, _ *cli.Command) error {
 | |
| 	ctx, cancel := installSignals(ctx)
 | |
| 	defer cancel()
 | |
| 
 | |
| 	if err := initDB(ctx); err != nil {
 | |
| 		return err
 | |
| 	}
 | |
| 
 | |
| 	if err := git.InitSimple(ctx); err != nil {
 | |
| 		return err
 | |
| 	}
 | |
| 
 | |
| 	log.Trace("Synchronizing repository releases (this may take a while)")
 | |
| 	for page := 1; ; page++ {
 | |
| 		repos, count, err := repo_model.SearchRepositoryByName(ctx, &repo_model.SearchRepoOptions{
 | |
| 			ListOptions: db.ListOptions{
 | |
| 				PageSize: repo_model.RepositoryListDefaultPageSize,
 | |
| 				Page:     page,
 | |
| 			},
 | |
| 			Private: true,
 | |
| 		})
 | |
| 		if err != nil {
 | |
| 			return fmt.Errorf("SearchRepositoryByName: %w", err)
 | |
| 		}
 | |
| 		if len(repos) == 0 {
 | |
| 			break
 | |
| 		}
 | |
| 		log.Trace("Processing next %d repos of %d", len(repos), count)
 | |
| 		for _, repo := range repos {
 | |
| 			log.Trace("Synchronizing repo %s with path %s", repo.FullName(), repo.RepoPath())
 | |
| 			gitRepo, err := gitrepo.OpenRepository(ctx, repo)
 | |
| 			if err != nil {
 | |
| 				log.Warn("OpenRepository: %v", err)
 | |
| 				continue
 | |
| 			}
 | |
| 
 | |
| 			oldnum, err := getReleaseCount(ctx, repo.ID)
 | |
| 			if err != nil {
 | |
| 				log.Warn(" GetReleaseCountByRepoID: %v", err)
 | |
| 			}
 | |
| 			log.Trace(" currentNumReleases is %d, running SyncReleasesWithTags", oldnum)
 | |
| 
 | |
| 			if err = repo_module.SyncReleasesWithTags(ctx, repo, gitRepo); err != nil {
 | |
| 				log.Warn(" SyncReleasesWithTags: %v", err)
 | |
| 				gitRepo.Close()
 | |
| 				continue
 | |
| 			}
 | |
| 
 | |
| 			count, err = getReleaseCount(ctx, repo.ID)
 | |
| 			if err != nil {
 | |
| 				log.Warn(" GetReleaseCountByRepoID: %v", err)
 | |
| 				gitRepo.Close()
 | |
| 				continue
 | |
| 			}
 | |
| 
 | |
| 			log.Trace(" repo %s releases synchronized to tags: from %d to %d",
 | |
| 				repo.FullName(), oldnum, count)
 | |
| 			gitRepo.Close()
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	return nil
 | |
| }
 | |
| 
 | |
| func getReleaseCount(ctx context.Context, id int64) (int64, error) {
 | |
| 	return db.Count[repo_model.Release](
 | |
| 		ctx,
 | |
| 		repo_model.FindReleasesOptions{
 | |
| 			RepoID:      id,
 | |
| 			IncludeTags: true,
 | |
| 		},
 | |
| 	)
 | |
| }
 |