2023-02-01 06:10:54 +08:00
|
|
|
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
|
Enable forbidigo linter (#24278)
Enable [forbidigo](https://github.com/ashanbrown/forbidigo) linter which
forbids print statements. Will check how to integrate this with the
smallest impact possible, so a few `nolint` comments will likely be
required. Plan is to just go through the issues and either:
- Remove the print if it is nonsensical
- Add a `//nolint` directive if it makes sense
I don't plan on investigating the individual issues any further.
<details>
<summary>Initial Lint Results</summary>
```
modules/log/event.go:348:6: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(err)
^
modules/log/event.go:382:6: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(err)
^
modules/queue/unique_queue_disk_channel_test.go:20:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("TempDir %s\n", tmpDir)
^
contrib/backport/backport.go:168:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Backporting %s to %s as %s\n", pr, localReleaseBranch, backportBranch)
^
contrib/backport/backport.go:216:4: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Navigate to %s to open PR\n", url)
^
contrib/backport/backport.go:223:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* `xdg-open %s`\n", url)
^
contrib/backport/backport.go:233:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* `git push -u %s %s`\n", remote, backportBranch)
^
contrib/backport/backport.go:243:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Amending commit to prepend `Backport #%s` to body\n", pr)
^
contrib/backport/backport.go:272:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("* Attempting git cherry-pick --continue")
^
contrib/backport/backport.go:281:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Attempting git cherry-pick %s\n", sha)
^
contrib/backport/backport.go:297:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Current branch is %s\n", currentBranch)
^
contrib/backport/backport.go:299:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Current branch is %s - not checking out\n", currentBranch)
^
contrib/backport/backport.go:304:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* Branch %s already exists. Checking it out...\n", backportBranch)
^
contrib/backport/backport.go:308:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* `git checkout -b %s %s`\n", backportBranch, releaseBranch)
^
contrib/backport/backport.go:313:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* `git fetch %s main`\n", remote)
^
contrib/backport/backport.go:316:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(string(out))
^
contrib/backport/backport.go:319:2: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(string(out))
^
contrib/backport/backport.go:321:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("* `git fetch %s %s`\n", remote, releaseBranch)
^
contrib/backport/backport.go:324:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(string(out))
^
contrib/backport/backport.go:327:2: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(string(out))
^
models/unittest/fixtures.go:50:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Unsupported RDBMS for integration tests")
^
models/unittest/fixtures.go:89:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("LoadFixtures failed after retries: %v\n", err)
^
models/unittest/fixtures.go:110:4: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Failed to generate sequence update: %v\n", err)
^
models/unittest/fixtures.go:117:6: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Failed to update sequence: %s Error: %v\n", value, err)
^
models/migrations/base/tests.go:118:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Environment variable $GITEA_ROOT not set")
^
models/migrations/base/tests.go:127:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Could not find gitea binary at %s\n", setting.AppPath)
^
models/migrations/base/tests.go:134:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Environment variable $GITEA_CONF not set - defaulting to %s\n", giteaConf)
^
models/migrations/base/tests.go:145:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Unable to create temporary data path %v\n", err)
^
models/migrations/base/tests.go:154:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Unable to InitFull: %v\n", err)
^
models/migrations/v1_11/v112.go:34:5: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Error: %v", err)
^
contrib/fixtures/fixture_generation.go:36:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("CreateTestEngine: %+v", err)
^
contrib/fixtures/fixture_generation.go:40:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("PrepareTestDatabase: %+v\n", err)
^
contrib/fixtures/fixture_generation.go:46:5: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("generate '%s': %+v\n", r, err)
^
contrib/fixtures/fixture_generation.go:53:5: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("generate '%s': %+v\n", g.name, err)
^
contrib/fixtures/fixture_generation.go:71:4: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s created.\n", path)
^
services/gitdiff/gitdiff_test.go:543:2: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println(result)
^
services/gitdiff/gitdiff_test.go:560:2: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println(result)
^
services/gitdiff/gitdiff_test.go:577:2: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println(result)
^
modules/web/routing/logger_manager.go:34:2: use of `print` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
print Printer
^
modules/doctor/paths.go:109:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Warning: can't remove temporary file: '%s'\n", tmpFile.Name())
^
tests/test_utils.go:33:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf(format+"\n", args...)
^
tests/test_utils.go:61:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Environment variable $GITEA_CONF not set, use default: %s\n", giteaConf)
^
cmd/actions.go:54:9: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
_, _ = fmt.Printf("%s\n", respText)
^
cmd/admin_user_change_password.go:74:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s's password has been successfully updated!\n", user.Name)
^
cmd/admin_user_create.go:109:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("generated random password is '%s'\n", password)
^
cmd/admin_user_create.go:164:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Access token was successfully created... %s\n", t.Token)
^
cmd/admin_user_create.go:167:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("New user '%s' has been successfully created!\n", username)
^
cmd/admin_user_generate_access_token.go:74:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s\n", t.Token)
^
cmd/admin_user_generate_access_token.go:76:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Access token was successfully created: %s\n", t.Token)
^
cmd/admin_user_must_change_password.go:56:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Updated %d users setting MustChangePassword to %t\n", n, mustChangePassword)
^
cmd/convert.go:44:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Converted successfully, please confirm your database's character set is now utf8mb4")
^
cmd/convert.go:50:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Converted successfully, please confirm your database's all columns character is NVARCHAR now")
^
cmd/convert.go:52:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("This command can only be used with a MySQL or MSSQL database")
^
cmd/doctor.go:104:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(err)
^
cmd/doctor.go:105:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Check if you are using the right config file. You can use a --config directive to specify one.")
^
cmd/doctor.go:243:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(err)
^
cmd/embedded.go:154:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(a.path)
^
cmd/embedded.go:198:3: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("Using app.ini at", setting.CustomConf)
^
cmd/embedded.go:217:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Extracting to %s:\n", destdir)
^
cmd/embedded.go:253:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s already exists; skipped.\n", dest)
^
cmd/embedded.go:275:2: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(dest)
^
cmd/generate.go:63:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s", internalToken)
^
cmd/generate.go:66:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("\n")
^
cmd/generate.go:78:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s", JWTSecretBase64)
^
cmd/generate.go:81:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("\n")
^
cmd/generate.go:93:2: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s", secretKey)
^
cmd/generate.go:96:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("\n")
^
cmd/keys.go:74:2: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println(strings.TrimSpace(authorizedString))
^
cmd/mailer.go:32:4: use of `fmt.Print` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Print("warning: Content is empty")
^
cmd/mailer.go:35:3: use of `fmt.Print` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Print("Proceed with sending email? [Y/n] ")
^
cmd/mailer.go:40:4: use of `fmt.Println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Println("The mail was not sent")
^
cmd/mailer.go:49:9: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
_, _ = fmt.Printf("Sent %s email(s) to all users\n", respText)
^
cmd/serv.go:147:3: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println("Gitea: SSH has been disabled")
^
cmd/serv.go:153:4: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("error showing subcommand help: %v\n", err)
^
cmd/serv.go:175:4: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println("Hi there! You've successfully authenticated with the deploy key named " + key.Name + ", but Gitea does not provide shell access.")
^
cmd/serv.go:177:4: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println("Hi there! You've successfully authenticated with the principal " + key.Content + ", but Gitea does not provide shell access.")
^
cmd/serv.go:179:4: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println("Hi there, " + user.Name + "! You've successfully authenticated with the key named " + key.Name + ", but Gitea does not provide shell access.")
^
cmd/serv.go:181:3: use of `println` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
println("If this is unexpected, please log in with password and setup Gitea under another user.")
^
cmd/serv.go:196:5: use of `fmt.Print` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Print(`{"type":"gitea","version":1}`)
^
tests/e2e/e2e_test.go:54:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Error initializing test database: %v\n", err)
^
tests/e2e/e2e_test.go:63:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("util.RemoveAll: %v\n", err)
^
tests/e2e/e2e_test.go:67:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Unable to remove repo indexer: %v\n", err)
^
tests/e2e/e2e_test.go:109:6: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%v", stdout.String())
^
tests/e2e/e2e_test.go:110:6: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%v", stderr.String())
^
tests/e2e/e2e_test.go:113:6: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%v", stdout.String())
^
tests/integration/integration_test.go:124:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Error initializing test database: %v\n", err)
^
tests/integration/integration_test.go:135:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("util.RemoveAll: %v\n", err)
^
tests/integration/integration_test.go:139:3: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("Unable to remove repo indexer: %v\n", err)
^
tests/integration/repo_test.go:357:4: use of `fmt.Printf` forbidden by pattern `^(fmt\.Print(|f|ln)|print|println)$` (forbidigo)
fmt.Printf("%s", resp.Body)
^
```
</details>
---------
Co-authored-by: Giteabot <teabot@gitea.io>
2023-04-24 17:50:58 +08:00
|
|
|
//nolint:forbidigo
|
2023-02-01 06:10:54 +08:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"fmt"
|
|
|
|
"log"
|
|
|
|
"net/http"
|
|
|
|
"os"
|
|
|
|
"os/exec"
|
|
|
|
"os/signal"
|
|
|
|
"path"
|
|
|
|
"strconv"
|
|
|
|
"strings"
|
|
|
|
"syscall"
|
|
|
|
|
2023-04-08 19:27:30 +08:00
|
|
|
"github.com/google/go-github/v51/github"
|
2023-02-01 06:10:54 +08:00
|
|
|
"github.com/urfave/cli"
|
|
|
|
"gopkg.in/yaml.v3"
|
|
|
|
)
|
|
|
|
|
|
|
|
const defaultVersion = "v1.18" // to backport to
|
|
|
|
|
|
|
|
func main() {
|
|
|
|
app := cli.NewApp()
|
|
|
|
app.Name = "backport"
|
|
|
|
app.Usage = "Backport provided PR-number on to the current or previous released version"
|
|
|
|
app.Description = `Backport will look-up the PR in Gitea's git log and attempt to cherry-pick it on the current version`
|
|
|
|
app.ArgsUsage = "<PR-to-backport>"
|
|
|
|
|
|
|
|
app.Flags = []cli.Flag{
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "version",
|
|
|
|
Usage: "Version branch to backport on to",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "upstream",
|
|
|
|
Value: "origin",
|
|
|
|
Usage: "Upstream remote for the Gitea upstream",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "release-branch",
|
|
|
|
Value: "",
|
|
|
|
Usage: "Release branch to backport on. Will default to release/<version>",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "cherry-pick",
|
|
|
|
Usage: "SHA to cherry-pick as backport",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "backport-branch",
|
|
|
|
Usage: "Backport branch to backport on to (default: backport-<pr>-<version>",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "remote",
|
|
|
|
Value: "",
|
|
|
|
Usage: "Remote for your fork of the Gitea upstream",
|
|
|
|
},
|
|
|
|
cli.StringFlag{
|
|
|
|
Name: "fork-user",
|
|
|
|
Value: "",
|
|
|
|
Usage: "Forked user name on Github",
|
|
|
|
},
|
|
|
|
cli.BoolFlag{
|
|
|
|
Name: "no-fetch",
|
|
|
|
Usage: "Set this flag to prevent fetch of remote branches",
|
|
|
|
},
|
|
|
|
cli.BoolFlag{
|
|
|
|
Name: "no-amend-message",
|
|
|
|
Usage: "Set this flag to prevent automatic amendment of the commit message",
|
|
|
|
},
|
|
|
|
cli.BoolFlag{
|
|
|
|
Name: "no-push",
|
|
|
|
Usage: "Set this flag to prevent pushing the backport up to your fork",
|
|
|
|
},
|
|
|
|
cli.BoolFlag{
|
|
|
|
Name: "no-xdg-open",
|
|
|
|
Usage: "Set this flag to not use xdg-open to open the PR URL",
|
|
|
|
},
|
2023-02-16 17:48:08 +08:00
|
|
|
cli.BoolFlag{
|
|
|
|
Name: "continue",
|
|
|
|
Usage: "Set this flag to continue from a git cherry-pick that has broken",
|
|
|
|
},
|
2023-02-01 06:10:54 +08:00
|
|
|
}
|
|
|
|
cli.AppHelpTemplate = `NAME:
|
|
|
|
{{.Name}} - {{.Usage}}
|
|
|
|
USAGE:
|
|
|
|
{{.HelpName}} {{if .VisibleFlags}}[options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}
|
|
|
|
{{if len .Authors}}
|
|
|
|
AUTHOR:
|
|
|
|
{{range .Authors}}{{ . }}{{end}}
|
|
|
|
{{end}}{{if .Commands}}
|
|
|
|
OPTIONS:
|
|
|
|
{{range .VisibleFlags}}{{.}}
|
|
|
|
{{end}}{{end}}
|
|
|
|
`
|
|
|
|
|
|
|
|
app.Action = runBackport
|
|
|
|
|
|
|
|
if err := app.Run(os.Args); err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to backport: %v\n", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func runBackport(c *cli.Context) error {
|
|
|
|
ctx, cancel := installSignals()
|
|
|
|
defer cancel()
|
|
|
|
|
2023-02-16 17:48:08 +08:00
|
|
|
continuing := c.Bool("continue")
|
|
|
|
|
|
|
|
var pr string
|
|
|
|
|
2023-02-01 06:10:54 +08:00
|
|
|
version := c.String("version")
|
2023-02-16 17:48:08 +08:00
|
|
|
if version == "" && continuing {
|
|
|
|
// determine version from current branch name
|
|
|
|
var err error
|
|
|
|
pr, version, err = readCurrentBranch(ctx)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
2023-02-01 06:10:54 +08:00
|
|
|
if version == "" {
|
|
|
|
version = readVersion()
|
|
|
|
}
|
|
|
|
if version == "" {
|
|
|
|
version = defaultVersion
|
|
|
|
}
|
|
|
|
|
|
|
|
upstream := c.String("upstream")
|
|
|
|
if upstream == "" {
|
|
|
|
upstream = "origin"
|
|
|
|
}
|
|
|
|
|
|
|
|
forkUser := c.String("fork-user")
|
|
|
|
remote := c.String("remote")
|
|
|
|
if remote == "" && !c.Bool("--no-push") {
|
|
|
|
var err error
|
|
|
|
remote, forkUser, err = determineRemote(ctx, forkUser)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
upstreamReleaseBranch := c.String("release-branch")
|
|
|
|
if upstreamReleaseBranch == "" {
|
|
|
|
upstreamReleaseBranch = path.Join("release", version)
|
|
|
|
}
|
|
|
|
|
|
|
|
localReleaseBranch := path.Join(upstream, upstreamReleaseBranch)
|
|
|
|
|
|
|
|
args := c.Args()
|
2023-02-16 17:48:08 +08:00
|
|
|
if len(args) == 0 && pr == "" {
|
2023-02-01 06:10:54 +08:00
|
|
|
return fmt.Errorf("no PR number provided\nProvide a PR number to backport")
|
2023-02-16 17:48:08 +08:00
|
|
|
} else if len(args) != 1 && pr == "" {
|
2023-02-01 06:10:54 +08:00
|
|
|
return fmt.Errorf("multiple PRs provided %v\nOnly a single PR can be backported at a time", args)
|
|
|
|
}
|
2023-02-16 17:48:08 +08:00
|
|
|
if pr == "" {
|
|
|
|
pr = args[0]
|
|
|
|
}
|
2023-02-01 06:10:54 +08:00
|
|
|
|
|
|
|
backportBranch := c.String("backport-branch")
|
|
|
|
if backportBranch == "" {
|
|
|
|
backportBranch = "backport-" + pr + "-" + version
|
|
|
|
}
|
|
|
|
|
|
|
|
fmt.Printf("* Backporting %s to %s as %s\n", pr, localReleaseBranch, backportBranch)
|
|
|
|
|
|
|
|
sha := c.String("cherry-pick")
|
|
|
|
if sha == "" {
|
|
|
|
var err error
|
|
|
|
sha, err = determineSHAforPR(ctx, pr)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if sha == "" {
|
|
|
|
return fmt.Errorf("unable to determine sha for cherry-pick of %s", pr)
|
|
|
|
}
|
|
|
|
|
|
|
|
if !c.Bool("no-fetch") {
|
|
|
|
if err := fetchRemoteAndMain(ctx, upstream, upstreamReleaseBranch); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-02-16 17:48:08 +08:00
|
|
|
if !continuing {
|
|
|
|
if err := checkoutBackportBranch(ctx, backportBranch, localReleaseBranch); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2023-02-01 06:10:54 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
if err := cherrypick(ctx, sha); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if !c.Bool("no-amend-message") {
|
|
|
|
if err := amendCommit(ctx, pr); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if !c.Bool("no-push") {
|
|
|
|
url := "https://github.com/go-gitea/gitea/compare/" + upstreamReleaseBranch + "..." + forkUser + ":" + backportBranch
|
|
|
|
|
|
|
|
if err := gitPushUp(ctx, remote, backportBranch); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if !c.Bool("no-xdg-open") {
|
|
|
|
if err := xdgOpen(ctx, url); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
fmt.Printf("* Navigate to %s to open PR\n", url)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func xdgOpen(ctx context.Context, url string) error {
|
|
|
|
fmt.Printf("* `xdg-open %s`\n", url)
|
|
|
|
out, err := exec.CommandContext(ctx, "xdg-open", url).Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "%s", string(out))
|
|
|
|
return fmt.Errorf("unable to xdg-open to %s: %w", url, err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func gitPushUp(ctx context.Context, remote, backportBranch string) error {
|
|
|
|
fmt.Printf("* `git push -u %s %s`\n", remote, backportBranch)
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "push", "-u", remote, backportBranch).Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "%s", string(out))
|
|
|
|
return fmt.Errorf("unable to push up to %s: %w", remote, err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func amendCommit(ctx context.Context, pr string) error {
|
|
|
|
fmt.Printf("* Amending commit to prepend `Backport #%s` to body\n", pr)
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "log", "-1", "--pretty=format:%B").Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "%s", string(out))
|
|
|
|
return fmt.Errorf("unable to get last log message: %w", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
parts := strings.SplitN(string(out), "\n", 2)
|
|
|
|
|
|
|
|
if len(parts) != 2 {
|
|
|
|
return fmt.Errorf("unable to interpret log message:\n%s", string(out))
|
|
|
|
}
|
|
|
|
subject, body := parts[0], parts[1]
|
|
|
|
if !strings.HasSuffix(subject, " (#"+pr+")") {
|
|
|
|
subject = subject + " (#" + pr + ")"
|
|
|
|
}
|
|
|
|
|
|
|
|
out, err = exec.CommandContext(ctx, "git", "commit", "--amend", "-m", subject+"\n\nBackport #"+pr+"\n"+body).Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "%s", string(out))
|
|
|
|
return fmt.Errorf("unable to amend last log message: %w", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func cherrypick(ctx context.Context, sha string) error {
|
|
|
|
// Check if a CHERRY_PICK_HEAD exists
|
|
|
|
if _, err := os.Stat(".git/CHERRY_PICK_HEAD"); err == nil {
|
|
|
|
// Assume that we are in the middle of cherry-pick - continue it
|
|
|
|
fmt.Println("* Attempting git cherry-pick --continue")
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "cherry-pick", "--continue").Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "git cherry-pick --continue failed:\n%s\n", string(out))
|
|
|
|
return fmt.Errorf("unable to continue cherry-pick: %w", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
fmt.Printf("* Attempting git cherry-pick %s\n", sha)
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "cherry-pick", sha).Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "git cherry-pick %s failed:\n%s\n", sha, string(out))
|
|
|
|
return fmt.Errorf("git cherry-pick %s failed: %w", sha, err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func checkoutBackportBranch(ctx context.Context, backportBranch, releaseBranch string) error {
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "branch", "--show-current").Output()
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to check current branch %w", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
currentBranch := strings.TrimSpace(string(out))
|
|
|
|
fmt.Printf("* Current branch is %s\n", currentBranch)
|
|
|
|
if currentBranch == backportBranch {
|
|
|
|
fmt.Printf("* Current branch is %s - not checking out\n", currentBranch)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, err := exec.CommandContext(ctx, "git", "rev-list", "-1", backportBranch).Output(); err == nil {
|
|
|
|
fmt.Printf("* Branch %s already exists. Checking it out...\n", backportBranch)
|
|
|
|
return exec.CommandContext(ctx, "git", "checkout", "-f", backportBranch).Run()
|
|
|
|
}
|
|
|
|
|
|
|
|
fmt.Printf("* `git checkout -b %s %s`\n", backportBranch, releaseBranch)
|
|
|
|
return exec.CommandContext(ctx, "git", "checkout", "-b", backportBranch, releaseBranch).Run()
|
|
|
|
}
|
|
|
|
|
|
|
|
func fetchRemoteAndMain(ctx context.Context, remote, releaseBranch string) error {
|
|
|
|
fmt.Printf("* `git fetch %s main`\n", remote)
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "fetch", remote, "main").Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println(string(out))
|
|
|
|
return fmt.Errorf("unable to fetch %s from %s: %w", "main", remote, err)
|
|
|
|
}
|
|
|
|
fmt.Println(string(out))
|
|
|
|
|
|
|
|
fmt.Printf("* `git fetch %s %s`\n", remote, releaseBranch)
|
|
|
|
out, err = exec.CommandContext(ctx, "git", "fetch", remote, releaseBranch).Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println(string(out))
|
|
|
|
return fmt.Errorf("unable to fetch %s from %s: %w", releaseBranch, remote, err)
|
|
|
|
}
|
|
|
|
fmt.Println(string(out))
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func determineRemote(ctx context.Context, forkUser string) (string, string, error) {
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "remote", "-v").Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to list git remotes:\n%s\n", string(out))
|
|
|
|
return "", "", fmt.Errorf("unable to determine forked remote: %w", err)
|
|
|
|
}
|
|
|
|
lines := strings.Split(string(out), "\n")
|
|
|
|
for _, line := range lines {
|
|
|
|
fields := strings.Split(line, "\t")
|
|
|
|
name, remote := fields[0], fields[1]
|
|
|
|
// only look at pushers
|
|
|
|
if !strings.HasSuffix(remote, " (push)") {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// only look at github.com pushes
|
|
|
|
if !strings.Contains(remote, "github.com") {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// ignore go-gitea/gitea
|
|
|
|
if strings.Contains(remote, "go-gitea/gitea") {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if !strings.Contains(remote, forkUser) {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if strings.HasPrefix(remote, "git@github.com:") {
|
|
|
|
forkUser = strings.TrimPrefix(remote, "git@github.com:")
|
|
|
|
} else if strings.HasPrefix(remote, "https://github.com/") {
|
|
|
|
forkUser = strings.TrimPrefix(remote, "https://github.com/")
|
|
|
|
} else if strings.HasPrefix(remote, "https://www.github.com/") {
|
|
|
|
forkUser = strings.TrimPrefix(remote, "https://www.github.com/")
|
|
|
|
} else if forkUser == "" {
|
|
|
|
return "", "", fmt.Errorf("unable to extract forkUser from remote %s: %s", name, remote)
|
|
|
|
}
|
|
|
|
idx := strings.Index(forkUser, "/")
|
|
|
|
if idx >= 0 {
|
|
|
|
forkUser = forkUser[:idx]
|
|
|
|
}
|
|
|
|
return name, forkUser, nil
|
|
|
|
}
|
|
|
|
return "", "", fmt.Errorf("unable to find appropriate remote in:\n%s", string(out))
|
|
|
|
}
|
|
|
|
|
2023-02-16 17:48:08 +08:00
|
|
|
func readCurrentBranch(ctx context.Context) (pr, version string, err error) {
|
|
|
|
out, err := exec.CommandContext(ctx, "git", "branch", "--show-current").Output()
|
|
|
|
if err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to read current git branch:\n%s\n", string(out))
|
|
|
|
return "", "", fmt.Errorf("unable to read current git branch: %w", err)
|
|
|
|
}
|
|
|
|
parts := strings.Split(strings.TrimSpace(string(out)), "-")
|
|
|
|
|
|
|
|
if len(parts) != 3 || parts[0] != "backport" {
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to continue from git branch:\n%s\n", string(out))
|
|
|
|
return "", "", fmt.Errorf("unable to continue from git branch:\n%s", string(out))
|
|
|
|
}
|
|
|
|
|
|
|
|
return parts[1], parts[2], nil
|
|
|
|
}
|
|
|
|
|
2023-02-01 06:10:54 +08:00
|
|
|
func readVersion() string {
|
|
|
|
bs, err := os.ReadFile("docs/config.yaml")
|
|
|
|
if err != nil {
|
|
|
|
if err == os.ErrNotExist {
|
|
|
|
log.Println("`docs/config.yaml` not present")
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to read `docs/config.yaml`: %v\n", err)
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
type params struct {
|
|
|
|
Version string
|
|
|
|
}
|
|
|
|
type docConfig struct {
|
|
|
|
Params params
|
|
|
|
}
|
|
|
|
dc := &docConfig{}
|
|
|
|
if err := yaml.Unmarshal(bs, dc); err != nil {
|
|
|
|
fmt.Fprintf(os.Stderr, "Unable to read `docs/config.yaml`: %v\n", err)
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
if dc.Params.Version == "" {
|
|
|
|
fmt.Fprintf(os.Stderr, "No version in `docs/config.yaml`")
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
version := dc.Params.Version
|
|
|
|
if version[0] != 'v' {
|
|
|
|
version = "v" + version
|
|
|
|
}
|
|
|
|
|
|
|
|
split := strings.SplitN(version, ".", 3)
|
|
|
|
|
|
|
|
return strings.Join(split[:2], ".")
|
|
|
|
}
|
|
|
|
|
|
|
|
func determineSHAforPR(ctx context.Context, prStr string) (string, error) {
|
|
|
|
prNum, err := strconv.Atoi(prStr)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
client := github.NewClient(http.DefaultClient)
|
|
|
|
|
|
|
|
pr, _, err := client.PullRequests.Get(ctx, "go-gitea", "gitea", prNum)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
if pr.Merged == nil || !*pr.Merged {
|
|
|
|
return "", fmt.Errorf("PR #%d is not yet merged - cannot determine sha to backport", prNum)
|
|
|
|
}
|
|
|
|
|
|
|
|
if pr.MergeCommitSHA != nil {
|
|
|
|
return *pr.MergeCommitSHA, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return "", nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func installSignals() (context.Context, context.CancelFunc) {
|
|
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
|
|
go func() {
|
|
|
|
// install notify
|
|
|
|
signalChannel := make(chan os.Signal, 1)
|
|
|
|
|
|
|
|
signal.Notify(
|
|
|
|
signalChannel,
|
|
|
|
syscall.SIGINT,
|
|
|
|
syscall.SIGTERM,
|
|
|
|
)
|
|
|
|
select {
|
|
|
|
case <-signalChannel:
|
|
|
|
case <-ctx.Done():
|
|
|
|
}
|
|
|
|
cancel()
|
|
|
|
signal.Reset()
|
|
|
|
}()
|
|
|
|
|
|
|
|
return ctx, cancel
|
|
|
|
}
|