Skip to content

Commit 840830b

Browse files
CaiCandongwolfogre
andauthored
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>
1 parent d57e55c commit 840830b

File tree

9 files changed

+45
-44
lines changed

9 files changed

+45
-44
lines changed

models/git/commit_status_test.go

-4
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ func TestGetCommitStatuses(t *testing.T) {
3131
assert.Equal(t, structs.CommitStatusPending, statuses[0].State)
3232
assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[0].APIURL(db.DefaultContext))
3333

34-
assert.Equal(t, "cov/awesomeness", statuses[1].Context)
35-
assert.Equal(t, structs.CommitStatusWarning, statuses[1].State)
36-
assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[1].APIURL(db.DefaultContext))
37-
3834
assert.Equal(t, "cov/awesomeness", statuses[2].Context)
3935
assert.Equal(t, structs.CommitStatusSuccess, statuses[2].State)
4036
assert.Equal(t, "https://try.gitea.io/api/v1/repos/user2/repo1/statuses/1234123412341234123412341234123412341234", statuses[2].APIURL(db.DefaultContext))

models/migrations/migrations.go

+2
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,8 @@ var migrations = []Migration{
513513
NewMigration("Add branch table", v1_21.AddBranchTable),
514514
// v265 -> v266
515515
NewMigration("Alter Actions Artifact table", v1_21.AlterActionArtifactTable),
516+
// v266 -> v267
517+
NewMigration("Reduce commit status", v1_21.ReduceCommitStatus),
516518
}
517519

518520
// GetCurrentDBVersion returns the current db version

models/migrations/v1_21/v266.go

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Copyright 2023 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package v1_21 //nolint
5+
6+
import (
7+
"xorm.io/xorm"
8+
)
9+
10+
func ReduceCommitStatus(x *xorm.Engine) error {
11+
sess := x.NewSession()
12+
defer sess.Close()
13+
14+
if err := sess.Begin(); err != nil {
15+
return err
16+
}
17+
18+
if _, err := sess.Exec(`UPDATE commit_status SET state='pending' WHERE state='running'`); err != nil {
19+
return err
20+
}
21+
if _, err := sess.Exec(`UPDATE commit_status SET state='failure' WHERE state='warning'`); err != nil {
22+
return err
23+
}
24+
25+
return sess.Commit()
26+
}

modules/structs/commit_status.go

+6-20
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,17 @@ const (
1616
CommitStatusError CommitStatusState = "error"
1717
// CommitStatusFailure is for when the CommitStatus is Failure
1818
CommitStatusFailure CommitStatusState = "failure"
19-
// CommitStatusWarning is for when the CommitStatus is Warning
20-
CommitStatusWarning CommitStatusState = "warning"
21-
// CommitStatusRunning is for when the CommitStatus is Running
22-
CommitStatusRunning CommitStatusState = "running"
2319
)
2420

2521
// NoBetterThan returns true if this State is no better than the given State
2622
func (css CommitStatusState) NoBetterThan(css2 CommitStatusState) bool {
27-
switch css {
28-
case CommitStatusError:
29-
return true
30-
case CommitStatusFailure:
31-
return css2 != CommitStatusError
32-
case CommitStatusWarning:
33-
return css2 != CommitStatusError && css2 != CommitStatusFailure
34-
case CommitStatusPending:
35-
return css2 != CommitStatusError && css2 != CommitStatusFailure && css2 != CommitStatusWarning
36-
default:
37-
return css2 != CommitStatusError && css2 != CommitStatusFailure && css2 != CommitStatusWarning && css2 != CommitStatusPending
23+
commitStatusPriorities := map[CommitStatusState]int{
24+
CommitStatusError: 0,
25+
CommitStatusFailure: 1,
26+
CommitStatusPending: 2,
27+
CommitStatusSuccess: 3,
3828
}
29+
return commitStatusPriorities[css] <= commitStatusPriorities[css2]
3930
}
4031

4132
// IsPending represents if commit status state is pending
@@ -57,8 +48,3 @@ func (css CommitStatusState) IsError() bool {
5748
func (css CommitStatusState) IsFailure() bool {
5849
return css == CommitStatusFailure
5950
}
60-
61-
// IsWarning represents if commit status state is warning
62-
func (css CommitStatusState) IsWarning() bool {
63-
return css == CommitStatusWarning
64-
}

services/actions/commit_status.go

+2-6
Original file line numberDiff line numberDiff line change
@@ -137,14 +137,10 @@ func toCommitStatus(status actions_model.Status) api.CommitStatusState {
137137
switch status {
138138
case actions_model.StatusSuccess, actions_model.StatusSkipped:
139139
return api.CommitStatusSuccess
140-
case actions_model.StatusFailure:
140+
case actions_model.StatusFailure, actions_model.StatusCancelled:
141141
return api.CommitStatusFailure
142-
case actions_model.StatusCancelled:
143-
return api.CommitStatusWarning
144-
case actions_model.StatusWaiting, actions_model.StatusBlocked:
142+
case actions_model.StatusWaiting, actions_model.StatusBlocked, actions_model.StatusRunning:
145143
return api.CommitStatusPending
146-
case actions_model.StatusRunning:
147-
return api.CommitStatusRunning
148144
default:
149145
return api.CommitStatusError
150146
}

services/convert/status.go

+8
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ func ToCombinedStatus(ctx context.Context, statuses []*git_model.CommitStatus, r
5252
retStatus.State = status.State
5353
}
5454
}
55+
// According to https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference
56+
// > Additionally, a combined state is returned. The state is one of:
57+
// > failure if any of the contexts report as error or failure
58+
// > pending if there are no statuses or a context is pending
59+
// > success if the latest status for all contexts is success
60+
if retStatus.State.IsError() {
61+
retStatus.State = api.CommitStatusFailure
62+
}
5563

5664
return retStatus
5765
}

templates/repo/commit_status.tmpl

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{if or (eq .State "pending") (eq .State "running")}}
1+
{{if eq .State "pending"}}
22
{{svg "octicon-dot-fill" 18 "commit-status icon text yellow"}}
33
{{end}}
44
{{if eq .State "success"}}
@@ -10,6 +10,3 @@
1010
{{if eq .State "failure"}}
1111
{{svg "octicon-x" 18 "commit-status icon text red"}}
1212
{{end}}
13-
{{if eq .State "warning"}}
14-
{{svg "gitea-exclamation" 18 "commit-status icon text yellow"}}
15-
{{end}}

tests/integration/pull_status_test.go

-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ func TestPullCreate_CommitStatus(t *testing.T) {
5252
api.CommitStatusPending,
5353
api.CommitStatusError,
5454
api.CommitStatusFailure,
55-
api.CommitStatusWarning,
5655
api.CommitStatusSuccess,
5756
}
5857

@@ -61,7 +60,6 @@ func TestPullCreate_CommitStatus(t *testing.T) {
6160
api.CommitStatusSuccess: "octicon-check",
6261
api.CommitStatusError: "gitea-exclamation",
6362
api.CommitStatusFailure: "octicon-x",
64-
api.CommitStatusWarning: "gitea-exclamation",
6563
}
6664

6765
testCtx := NewAPITestContext(t, "user1", "repo1", auth_model.AccessTokenScopeWriteRepository)

tests/integration/repo_commits_test.go

-8
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,6 @@ func TestRepoCommitsWithStatusFailure(t *testing.T) {
125125
doTestRepoCommitWithStatus(t, "failure", "octicon-x", "red")
126126
}
127127

128-
func TestRepoCommitsWithStatusWarning(t *testing.T) {
129-
doTestRepoCommitWithStatus(t, "warning", "gitea-exclamation", "yellow")
130-
}
131-
132-
func TestRepoCommitsWithStatusRunning(t *testing.T) {
133-
doTestRepoCommitWithStatus(t, "running", "octicon-dot-fill", "yellow")
134-
}
135-
136128
func TestRepoCommitsStatusParallel(t *testing.T) {
137129
defer tests.PrepareTestEnv(t)()
138130

0 commit comments

Comments
 (0)