mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-04 01:34:27 +00:00 
			
		
		
		
	Remove commit status running and warning to align GitHub (#25839)
Fix #25776. Close #25826. In the discussion of #25776, @wolfogre's suggestion was to remove the commit status of `running` and `warning` to keep it consistent with github. references: - https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#about-commit-statuses ## ⚠️ BREAKING ⚠️ So the commit status of Gitea will be consistent with GitHub, only `pending`, `success`, `error` and `failure`, while `warning` and `running` are not supported anymore. --------- Co-authored-by: Jason Song <i@wolfogre.com>
This commit is contained in:
		@@ -31,10 +31,6 @@ func TestGetCommitStatuses(t *testing.T) {
 | 
			
		||||
	assert.Equal(t, structs.CommitStatusPending, statuses[0].State)
 | 
			
		||||
	assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[0].APIURL(db.DefaultContext))
 | 
			
		||||
 | 
			
		||||
	assert.Equal(t, "cov/awesomeness", statuses[1].Context)
 | 
			
		||||
	assert.Equal(t, structs.CommitStatusWarning, statuses[1].State)
 | 
			
		||||
	assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[1].APIURL(db.DefaultContext))
 | 
			
		||||
 | 
			
		||||
	assert.Equal(t, "cov/awesomeness", statuses[2].Context)
 | 
			
		||||
	assert.Equal(t, structs.CommitStatusSuccess, statuses[2].State)
 | 
			
		||||
	assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[2].APIURL(db.DefaultContext))
 | 
			
		||||
 
 | 
			
		||||
@@ -513,6 +513,8 @@ var migrations = []Migration{
 | 
			
		||||
	NewMigration("Add branch table", v1_21.AddBranchTable),
 | 
			
		||||
	// v265 -> v266
 | 
			
		||||
	NewMigration("Alter Actions Artifact table", v1_21.AlterActionArtifactTable),
 | 
			
		||||
	// v266 -> v267
 | 
			
		||||
	NewMigration("Reduce commit status", v1_21.ReduceCommitStatus),
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GetCurrentDBVersion returns the current db version
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										26
									
								
								models/migrations/v1_21/v266.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								models/migrations/v1_21/v266.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,26 @@
 | 
			
		||||
// Copyright 2023 The Gitea Authors. All rights reserved.
 | 
			
		||||
// SPDX-License-Identifier: MIT
 | 
			
		||||
 | 
			
		||||
package v1_21 //nolint
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"xorm.io/xorm"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func ReduceCommitStatus(x *xorm.Engine) error {
 | 
			
		||||
	sess := x.NewSession()
 | 
			
		||||
	defer sess.Close()
 | 
			
		||||
 | 
			
		||||
	if err := sess.Begin(); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if _, err := sess.Exec(`UPDATE commit_status SET state='pending' WHERE state='running'`); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	if _, err := sess.Exec(`UPDATE commit_status SET state='failure' WHERE state='warning'`); err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return sess.Commit()
 | 
			
		||||
}
 | 
			
		||||
@@ -16,26 +16,17 @@ const (
 | 
			
		||||
	CommitStatusError CommitStatusState = "error"
 | 
			
		||||
	// CommitStatusFailure is for when the CommitStatus is Failure
 | 
			
		||||
	CommitStatusFailure CommitStatusState = "failure"
 | 
			
		||||
	// CommitStatusWarning is for when the CommitStatus is Warning
 | 
			
		||||
	CommitStatusWarning CommitStatusState = "warning"
 | 
			
		||||
	// CommitStatusRunning is for when the CommitStatus is Running
 | 
			
		||||
	CommitStatusRunning CommitStatusState = "running"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// NoBetterThan returns true if this State is no better than the given State
 | 
			
		||||
func (css CommitStatusState) NoBetterThan(css2 CommitStatusState) bool {
 | 
			
		||||
	switch css {
 | 
			
		||||
	case CommitStatusError:
 | 
			
		||||
		return true
 | 
			
		||||
	case CommitStatusFailure:
 | 
			
		||||
		return css2 != CommitStatusError
 | 
			
		||||
	case CommitStatusWarning:
 | 
			
		||||
		return css2 != CommitStatusError && css2 != CommitStatusFailure
 | 
			
		||||
	case CommitStatusPending:
 | 
			
		||||
		return css2 != CommitStatusError && css2 != CommitStatusFailure && css2 != CommitStatusWarning
 | 
			
		||||
	default:
 | 
			
		||||
		return css2 != CommitStatusError && css2 != CommitStatusFailure && css2 != CommitStatusWarning && css2 != CommitStatusPending
 | 
			
		||||
	commitStatusPriorities := map[CommitStatusState]int{
 | 
			
		||||
		CommitStatusError:   0,
 | 
			
		||||
		CommitStatusFailure: 1,
 | 
			
		||||
		CommitStatusPending: 2,
 | 
			
		||||
		CommitStatusSuccess: 3,
 | 
			
		||||
	}
 | 
			
		||||
	return commitStatusPriorities[css] <= commitStatusPriorities[css2]
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// IsPending represents if commit status state is pending
 | 
			
		||||
@@ -57,8 +48,3 @@ func (css CommitStatusState) IsError() bool {
 | 
			
		||||
func (css CommitStatusState) IsFailure() bool {
 | 
			
		||||
	return css == CommitStatusFailure
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// IsWarning represents if commit status state is warning
 | 
			
		||||
func (css CommitStatusState) IsWarning() bool {
 | 
			
		||||
	return css == CommitStatusWarning
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -137,14 +137,10 @@ func toCommitStatus(status actions_model.Status) api.CommitStatusState {
 | 
			
		||||
	switch status {
 | 
			
		||||
	case actions_model.StatusSuccess, actions_model.StatusSkipped:
 | 
			
		||||
		return api.CommitStatusSuccess
 | 
			
		||||
	case actions_model.StatusFailure:
 | 
			
		||||
	case actions_model.StatusFailure, actions_model.StatusCancelled:
 | 
			
		||||
		return api.CommitStatusFailure
 | 
			
		||||
	case actions_model.StatusCancelled:
 | 
			
		||||
		return api.CommitStatusWarning
 | 
			
		||||
	case actions_model.StatusWaiting, actions_model.StatusBlocked:
 | 
			
		||||
	case actions_model.StatusWaiting, actions_model.StatusBlocked, actions_model.StatusRunning:
 | 
			
		||||
		return api.CommitStatusPending
 | 
			
		||||
	case actions_model.StatusRunning:
 | 
			
		||||
		return api.CommitStatusRunning
 | 
			
		||||
	default:
 | 
			
		||||
		return api.CommitStatusError
 | 
			
		||||
	}
 | 
			
		||||
 
 | 
			
		||||
@@ -52,6 +52,14 @@ func ToCombinedStatus(ctx context.Context, statuses []*git_model.CommitStatus, r
 | 
			
		||||
			retStatus.State = status.State
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	// According to https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference
 | 
			
		||||
	// > Additionally, a combined state is returned. The state is one of:
 | 
			
		||||
	// > failure if any of the contexts report as error or failure
 | 
			
		||||
	// > pending if there are no statuses or a context is pending
 | 
			
		||||
	// > success if the latest status for all contexts is success
 | 
			
		||||
	if retStatus.State.IsError() {
 | 
			
		||||
		retStatus.State = api.CommitStatusFailure
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return retStatus
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
{{if or (eq .State "pending") (eq .State "running")}}
 | 
			
		||||
{{if eq .State "pending"}}
 | 
			
		||||
	{{svg "octicon-dot-fill" 18 "commit-status icon text yellow"}}
 | 
			
		||||
{{end}}
 | 
			
		||||
{{if eq .State "success"}}
 | 
			
		||||
@@ -10,6 +10,3 @@
 | 
			
		||||
{{if eq .State "failure"}}
 | 
			
		||||
	{{svg "octicon-x" 18 "commit-status icon text red"}}
 | 
			
		||||
{{end}}
 | 
			
		||||
{{if eq .State "warning"}}
 | 
			
		||||
	{{svg "gitea-exclamation" 18 "commit-status icon text yellow"}}
 | 
			
		||||
{{end}}
 | 
			
		||||
 
 | 
			
		||||
@@ -52,7 +52,6 @@ func TestPullCreate_CommitStatus(t *testing.T) {
 | 
			
		||||
			api.CommitStatusPending,
 | 
			
		||||
			api.CommitStatusError,
 | 
			
		||||
			api.CommitStatusFailure,
 | 
			
		||||
			api.CommitStatusWarning,
 | 
			
		||||
			api.CommitStatusSuccess,
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
@@ -61,7 +60,6 @@ func TestPullCreate_CommitStatus(t *testing.T) {
 | 
			
		||||
			api.CommitStatusSuccess: "octicon-check",
 | 
			
		||||
			api.CommitStatusError:   "gitea-exclamation",
 | 
			
		||||
			api.CommitStatusFailure: "octicon-x",
 | 
			
		||||
			api.CommitStatusWarning: "gitea-exclamation",
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		testCtx := NewAPITestContext(t, "user1", "repo1", auth_model.AccessTokenScopeWriteRepository)
 | 
			
		||||
 
 | 
			
		||||
@@ -125,14 +125,6 @@ func TestRepoCommitsWithStatusFailure(t *testing.T) {
 | 
			
		||||
	doTestRepoCommitWithStatus(t, "failure", "octicon-x", "red")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRepoCommitsWithStatusWarning(t *testing.T) {
 | 
			
		||||
	doTestRepoCommitWithStatus(t, "warning", "gitea-exclamation", "yellow")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRepoCommitsWithStatusRunning(t *testing.T) {
 | 
			
		||||
	doTestRepoCommitWithStatus(t, "running", "octicon-dot-fill", "yellow")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRepoCommitsStatusParallel(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user