0
0
mirror of https://github.com/go-gitea/gitea.git synced 2025-07-19 21:28:33 +02:00

improve comments

This commit is contained in:
wxiaoguang 2025-05-28 04:30:14 +08:00
parent 708b158aaf
commit 8c21f017da

View File

@ -231,8 +231,8 @@ func (status *CommitStatus) HideActionsURL(ctx context.Context) {
// CalcCommitStatus returns commit status state via some status, the commit statues should order by id desc
func CalcCommitStatus(statuses []*CommitStatus) *CommitStatus {
// This function is widely used, but it is not quite right.
// The bad case is: if all commits are "skipped", GitHub will return "success" as the combined status.
// But here Gitea just returns the first status, which is still "skipped" in this case.
// If all commits are "skipped", GitHub will return "success" as the combined status.
// FIXME: But the bad case here is: Gitea just returns the first status, which is still "skipped".
// Ideally it should return something like "CommitStatusSummary" with proper aggregated state.
var lastStatus *CommitStatus
state := api.CommitStatusSuccess
@ -244,8 +244,10 @@ func CalcCommitStatus(statuses []*CommitStatus) *CommitStatus {
}
if lastStatus == nil {
if len(statuses) > 0 {
// the bad case mentioned above: only the first status is returned, its status is "skipped"
lastStatus = statuses[0]
} else {
// FIXME: this is another bad case, if the "statuses" slice is empty, the returned value is an invalid CommitStatus, all its fields are empty.
lastStatus = &CommitStatus{}
}
}