Allow to change status context again (#674)

* use flag value

* fix test

* sed -i 's/STATUS_CONTEXT/WOODPECKER_STATUS_CONTEXT/g'

* docs

* Update docs/docs/91-migrations.md

Co-authored-by: Anbraten <anton@ju60.de>

cmd/server/flags.go

@@ -209,6 +209,12 @@ var flags = []cli.Flag{
 	//
 	// remote parameters
 	//
+	&cli.StringFlag{
+		EnvVars: []string{"WOODPECKER_STATUS_CONTEXT", "WOODPECKER_GITHUB_CONTEXT", "WOODPECKER_GITEA_CONTEXT"},
+		Name:    "status-context",
+		Usage:   "status context prefix",
+		Value:   "ci/woodpecker",
+	},
 	&cli.BoolFlag{
 		Name:    "flat-permissions",
 		Usage:   "no remote call for permissions should be made",
@@ -227,12 +233,6 @@ var flags = []cli.Flag{
 		Usage:   "github server address",
 		Value:   "https://github.com",
 	},
-	&cli.StringFlag{
-		EnvVars: []string{"WOODPECKER_GITHUB_CONTEXT"},
-		Name:    "github-context",
-		Usage:   "github status context",
-		Value:   "continuous-integration/woodpecker",
-	},
 	&cli.StringFlag{
 		EnvVars: []string{"WOODPECKER_GITHUB_CLIENT"},
 		Name:    "github-client",
@@ -332,12 +332,6 @@ var flags = []cli.Flag{
 		Name:    "gitea-secret",
 		Usage:   "gitea oauth2 client secret",
 	},
-	&cli.StringFlag{
-		EnvVars: []string{"WOODPECKER_GITEA_CONTEXT"},
-		Name:    "gitea-context",
-		Usage:   "gitea status context",
-		Value:   "continuous-integration/woodpecker",
-	},
 	&cli.StringFlag{
 		EnvVars: []string{"WOODPECKER_GITEA_GIT_USERNAME"},
 		Name:    "gitea-git-username",

cmd/server/server.go

@@ -296,6 +296,7 @@ func setupEvilGlobals(c *cli.Context, v store.Store, r remote.Remote) {
 	}
 	server.Config.Server.Port = c.String("server-addr")
 	server.Config.Server.Docs = c.String("docs")
+	server.Config.Server.StatusContext = c.String("status-context")
 	server.Config.Server.SessionExpires = c.Duration("session-expires")
 	server.Config.Pipeline.Networks = c.StringSlice("network")
 	server.Config.Pipeline.Volumes = c.StringSlice("volume")

cmd/server/setup.go

@@ -229,7 +229,6 @@ func setupGitea(c *cli.Context) (remote.Remote, error) {
 	}
 	opts := gitea.Opts{
 		URL:         strings.TrimRight(server.String(), "/"),
-		Context:     c.String("gitea-context"),
 		Username:    c.String("gitea-git-username"),
 		Password:    c.String("gitea-git-password"),
 		Client:      c.String("gitea-client"),
@@ -276,7 +275,6 @@ func setupGitlab(c *cli.Context) (remote.Remote, error) {
 func setupGithub(c *cli.Context) (remote.Remote, error) {
 	opts := github.Opts{
 		URL:         c.String("github-server"),
-		Context:     c.String("github-context"),
 		Client:      c.String("github-client"),
 		Secret:      c.String("github-secret"),
 		Scopes:      c.StringSlice("github-scope"),

docs/docs/91-migrations.md

@@ -67,6 +67,8 @@ Some versions need some changes to the server configuration or the pipeline conf
 
 - Dropped support for manually setting the agents platform with `WOODPECKER_PLATFORM`. The platform is now automatically detected.
 
+- Use `WOODPECKER_STATUS_CONTEXT` instead of the deprecated options `WOODPECKER_GITHUB_CONTEXT` and `WOODPECKER_GITEA_CONTEXT`.
+
 ## 0.14.0
 
 No breaking changes

server/config.go

@@ -56,6 +56,7 @@ var Config = struct {
 		Port           string
 		Pass           string
 		Docs           string
+		StatusContext  string
 		SessionExpires time.Duration
 		// Open bool
 		// Orgs map[string]struct{}

server/remote/common/status.go

@@ -7,10 +7,8 @@ import (
 	"github.com/woodpecker-ci/woodpecker/server/model"
 )
 
-const base = "ci/woodpecker"
-
 func GetBuildStatusContext(repo *model.Repo, build *model.Build, proc *model.Proc) string {
-	name := base
+	name := server.Config.Server.StatusContext
 
 	switch build.Event {
 	case model.EventPull:

server/remote/gitea/gitea.go

@@ -57,7 +57,6 @@ type Gitea struct {
 // Opts defines configuration options.
 type Opts struct {
 	URL         string // Gitea server url.
-	Context     string // Context to display in status check
 	Client      string // OAuth2 Client ID
 	Secret      string // OAuth2 Client Secret
 	Username    string // Optional machine account username.
@@ -79,7 +78,6 @@ func New(opts Opts) (remote.Remote, error) {
 	}
 	return &Gitea{
 		URL:          opts.URL,
-		Context:      opts.Context,
 		Machine:      u.Host,
 		ClientID:     opts.Client,
 		ClientSecret: opts.Secret,

server/remote/gitea/gitea_test.go

@@ -46,14 +46,12 @@ func Test_gitea(t *testing.T) {
 			g.It("Should return client with specified options", func() {
 				remote, _ := New(Opts{
 					URL:         "http://localhost:8080",
-					Context:     "continuous-integration/test",
 					Username:    "someuser",
 					Password:    "password",
 					SkipVerify:  true,
 					PrivateMode: true,
 				})
 				g.Assert(remote.(*Gitea).URL).Equal("http://localhost:8080")
-				g.Assert(remote.(*Gitea).Context).Equal("continuous-integration/test")
 				g.Assert(remote.(*Gitea).Machine).Equal("localhost")
 				g.Assert(remote.(*Gitea).Username).Equal("someuser")
 				g.Assert(remote.(*Gitea).Password).Equal("password")

server/remote/github/github.go

@@ -45,7 +45,6 @@ const (
 // Opts defines configuration options.
 type Opts struct {
 	URL         string   // GitHub server url.
-	Context     string   // Context to display in status check
 	Client      string   // GitHub oauth client id.
 	Secret      string   // GitHub oauth client secret.
 	Scopes      []string // GitHub oauth scopes
@@ -70,7 +69,6 @@ func New(opts Opts) (remote.Remote, error) {
 	r := &client{
 		API:         defaultAPI,
 		URL:         defaultURL,
-		Context:     opts.Context,
 		Client:      opts.Client,
 		Secret:      opts.Secret,
 		Scopes:      opts.Scopes,
@@ -91,7 +89,6 @@ func New(opts Opts) (remote.Remote, error) {
 
 type client struct {
 	URL         string
-	Context     string
 	API         string
 	Client      string
 	Secret      string

server/remote/github/github_test.go

@@ -52,7 +52,6 @@ func Test_github(t *testing.T) {
 					Password:    "password",
 					SkipVerify:  true,
 					PrivateMode: true,
-					Context:     "continuous-integration/test",
 				})
 				g.Assert(remote.(*client).URL).Equal("http://localhost:8080")
 				g.Assert(remote.(*client).API).Equal("http://localhost:8080/api/v3/")
@@ -63,7 +62,6 @@ func Test_github(t *testing.T) {
 				g.Assert(remote.(*client).Secret).Equal("I1NiIsInR5")
 				g.Assert(remote.(*client).SkipVerify).Equal(true)
 				g.Assert(remote.(*client).PrivateMode).Equal(true)
-				g.Assert(remote.(*client).Context).Equal("continuous-integration/test")
 			})
 			g.It("Should handle malformed url", func() {
 				_, err := New(Opts{URL: "%gh&%ij"})