Provide an API to set generic Pull-Request sidebar content

[silverwind]

Feature Description

It'd be nice if we could offer a API where third-party integrations like code coverage could create sidebar content into a PR, like for example coverage.

I could see it accepting something like

{
  "title": "CodeCov Coverage",
  "value": "55.32% (+0.15%)"
  "link": "https://codecov.example.com/pr-1234",
  "details": "more verbose markdown content..."
}

details and maybe value could accept Markdown. details content could be used to display a popup on mouseover that shows detailed content.

Related:

https://app.codecov.io/gh/feedback/p/support-gitea-scm
#23746 (comment)

[a1012112796]

looks check run feature in github is also good: https://docs.github.com/en/rest/guides/using-the-rest-api-to-interact-with-checks?apiVersion=2022-11-28

[jpraet]

For this example use case about reporting test coverage of a PR, isn't commit status suited for that?

https://try.gitea.io/api/swagger#/repository/repoCreateStatus

[silverwind]

For this example use case about reporting test coverage of a PR, isn't commit status suited for that?

I think it's insufficient. It can only show success/error/warning etc, which is fine for cases where you want strict coverage, e.g. only success a PR if coverage increases. But for detailed reporting like CodeCov does as comments currently on GitHub, it's not enough.

[lunny]

We need an standard API to store the coverage stats results. We can have a summary in the sidebar of pull request. And even more, we can display every file's coverage in pull request file view or commit file view.

[silverwind]

It could be generalized as "PR Metadata" and "PR file metadata" on the API. Thought I guess if we want to integrate deeply and show progress bars and such, there is no way around specifically supporting the coverage use case with specific APIs tailored to it.

[lunny]

It could be generalized as "PR Metadata" and "PR file metadata" on the API. Thought I guess if we want to integrate deeply and show progress bars and such, there is no way around specifically supporting the coverage use case with specific APIs tailored to it.

Just like commit status API, it will stick owner_name/repo_name and commit SHA, but not associated with a special PR. Because you don't know which model users will use with Gitea.

[a1012112796]

look the action also need it, ref: #23722 #23721

[a1012112796]

I think the checks run feature in github is a good solution for this issue, looks it's Upgraded commit status. the difference betwen check run and commit status :

in my view, looks check run = commit status + code review

some tips about do it:

• github api document: https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28
• wonder whether create a new table named as CheckRun or just upgrade the CommitStatus struct
• in github's document description, it bound with App feature, but in fact, looks it bound with Action also ...

---

• To show it on ui, maybe we can reuse commit status and code comment ui
• checkRun db struct in my view:

type ChekRun struct {
	ID         int64                  `xorm:"pk autoincr"`
	RepoID     int64                  `xorm:"INDEX UNIQUE(repo_sha_index)"`
	Repo       *repo_model.Repository `xorm:"-"`
	State      int64                  // difference with `CommitStatus`
	Conclusion int64                  // difference with `CommitStatus`

	SHA       string           `xorm:"VARCHAR(64) NOT NULL INDEX UNIQUE(repo_sha_index)"`
	TargetURL string           `xorm:"TEXT"`
	NameHash  string           `xorm:"char(40) index"`
	Name      string           `xorm:"TEXT"`
	Creator   *user_model.User `xorm:"-"`
	CreatorID int64

	StartAt     timeutil.TimeStamp // difference with `CommitStatus`
	CompletedAt timeutil.TimeStamp // difference with `CommitStatus`

	OutPut  *ChekRunOutPut  `xorm:"-"` // difference with `CommitStatus`
	Actions []ChekRunAction `xorm:"-"` // difference with `CommitStatus`

	CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
	UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
}

type ChekRunAnnotation struct {
	Path            string
	StartLine       int64
	EndLine         int64
	StartColumn     int64
	EndColumn       int64
	AnnotationLevel string
	Message         string
	Title           string
	RawDetails      string
}

type ChekRunOutPut struct {
	ID          int64 `xorm:"pk autoincr"`
	ChekcRunID  int64 `xorm:"INDEX"`
	Title       string
	Summary     string
	Text        string
	Annotations []ChekRunAnnotation `xorm:"JSON"`
}

type ChekRunAction struct {
	ID          int64 `xorm:"pk autoincr"`
	ChekcRunID  int64 `xorm:"INDEX"`
	Label       string
	Description string
	Identifier  string
	Url         string
}