Skip to content

Commit 92863bb

Browse files
aahlenstMathieu Fenniak
authored andcommitted
feat: expose run_id in ...actions/runners/jobs endpoint (#12480)
Include `run_id` in the responses emitted by all `...actions/runners/jobs` endpoints. Helps with correlating pending jobs with other jobs and the runs they belong to. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes (can be removed for JavaScript changes) - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Tests for JavaScript changes (can be removed for Go changes) - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12480 Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
1 parent 0b3192b commit 92863bb

7 files changed

Lines changed: 15 additions & 0 deletions

File tree

modules/structs/action.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import (
1212
type ActionRunJob struct {
1313
// Identifier of this job.
1414
ID int64 `json:"id"`
15+
// Identifier of the workflow run this job belongs to.
16+
RunID int64 `json:"run_id"`
1517
// How many times the job has been attempted including the current attempt.
1618
Attempt int64 `json:"attempt"`
1719
// Opaque identifier that uniquely identifies a single attempt of a job.

services/convert/action.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ func ToActionRunJob(job *actions_model.ActionRunJob) *api.ActionRunJob {
7171

7272
return &api.ActionRunJob{
7373
ID: job.ID,
74+
RunID: job.RunID,
7475
Attempt: job.Attempt,
7576
Handle: job.Handle,
7677
RepoID: job.RepoID,

templates/swagger/v1_json.tmpl

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/integration/api_admin_actions_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ func TestAPIAdminActionsGetJobs(t *testing.T) {
4646

4747
expected := api.ActionRunJob{
4848
ID: 393,
49+
RunID: 891,
4950
Attempt: 1,
5051
Handle: "18e9cf40-c2f6-409f-b832-b945ea7dc79b",
5152
RepoID: 1,

tests/integration/api_org_actions_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ func TestActionsAPISearchActionJobs_OrgRunner(t *testing.T) {
3737

3838
job395 := api.ActionRunJob{
3939
ID: 395,
40+
RunID: 891,
4041
Attempt: 1,
4142
Handle: "40317a2f-2f00-4a82-8cc4-57347989a493",
4243
RepoID: 1,

tests/integration/api_repo_actions_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ func TestActionsAPISearchActionJobs_RepoRunner(t *testing.T) {
5252

5353
job393 := api.ActionRunJob{
5454
ID: 393,
55+
RunID: 891,
5556
Attempt: 1,
5657
Handle: "18e9cf40-c2f6-409f-b832-b945ea7dc79b",
5758
RepoID: 1,
@@ -713,6 +714,7 @@ func TestActionsAPIListActionRunJobs(t *testing.T) {
713714
if expected.ID == 195 {
714715
assert.Equal(t, &api.ActionRunJob{
715716
ID: 195,
717+
RunID: 793,
716718
Attempt: 1,
717719
Handle: "",
718720
RepoID: 4,
@@ -726,6 +728,7 @@ func TestActionsAPIListActionRunJobs(t *testing.T) {
726728
} else if expected.ID == 197 {
727729
assert.Equal(t, &api.ActionRunJob{
728730
ID: 197,
731+
RunID: 895,
729732
Attempt: 0,
730733
Handle: "",
731734
RepoID: 4,

tests/integration/api_user_actions_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ func TestActionsAPISearchActionJobs_UserRunner(t *testing.T) {
3838

3939
job394 := api.ActionRunJob{
4040
ID: 394,
41+
RunID: 891,
4142
Attempt: 2,
4243
Handle: "a723d3e3-49a1-4e6b-947f-e987e60bfbd6",
4344
RepoID: 1,

0 commit comments

Comments
 (0)