Download actions job logs from API #33858

lunny · 2025-03-11T23:25:08Z

It's similar with https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#download-job-logs-for-a-workflow-run--code-samples.

This use job_id as path parameter which is consistent with Github's APIs.

wxiaoguang · 2025-03-12T04:44:19Z

I am sure you just copied & pasted the code from somewhere without understanding what each line does.

routers/api/v1/api.go

routers/api/v1/repo/actions_run.go

ChristopherHX · 2025-03-16T10:31:05Z

Works for me.

~~While testing I remembered workflow_job webhook uses jobid instead of job index for api url, to have the same field to url mapping for the url field as GitHub Rest.~~

~~e.g. http://localhost:3000/api/v1/repos/test/private-repo/actions/runs/842/jobs/373 (prefix of this logs endpoint)~~

~~instead of http://localhost:3000/api/v1/repos/test/private-repo/actions/runs/842/jobs/0.~~

~~And logs is below this path.~~

~~The swagger documention tells me I can use the id that is 404.~~

This use run_id as path parameter which is consistent with other APIs but not web routers. Maybe all web routers should change from run_index to run_id to keep consistent.

I would prefer run_id and job_id in both web routers and api. However I know that this is going to break existing commit status reports

I guess workflow_job webhook is currently a good way to obtain all ids to construct this url, we might need a workflow_run/workflow_job api route to make this really usable from scripts.

EDIT

Sorry some parts are incorrect from my side...

The gh compatible api path of workflow_job is the following, in this case only a id makes sense.

http://localhost:3000/api/v1/repos/test/private-repo/actions/jobs/373

ChristopherHX · 2025-03-16T21:38:01Z

We were looking at the wrong section of the gh docu.

You are implementing this endpoint https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#download-job-logs-for-a-workflow-run--code-samples under a different url.

The one from GitHub has no runs part in the url and uses the jobid instead of index

lunny · 2025-03-16T22:14:26Z

job_id is a string which is from the workflow not the id stored in the database.
ref https://docs.github.com/en/enterprise-cloud@latest/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_id

ChristopherHX · 2025-03-16T22:34:58Z

job_id is a string which is from the workflow not the id stored in the database.

GitHub is good in mixing names, yes job_id in workflow yaml is a string.

job_id in workflow_job api object is a number from the database see here:

ref https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#get-a-job-for-a-workflow-run

The example has a really big number, that is a global database id I guess

"id": 399444496,

GitHub Actions users have hard time to correlate a workflow execution from the runner to a workflow_job api id

ChristopherHX

Looks good to me, left some non functional suggestions

routers/api/v1/repo/actions_run.go

models/actions/run_job_list.go

Co-authored-by: ChristopherHX <christopher.homberger@web.de>

…unny/actions_log_api

* giteaofficial/main: [skip ci] Updated translations via Crowdin Download actions job logs from API (go-gitea#33858) Fail mirroring more gracefully (go-gitea#34002) Fix dropdown module accessing (go-gitea#34026) Polyfill WeakRef (go-gitea#34025) Fix dropdown delegating and some UI problems (go-gitea#34014)

lunny · 2025-03-27T19:33:28Z

routers/common/actions.go

-	var curJob *actions_model.ActionRunJob
-	if jobIndex >= 0 && jobIndex < int64(len(runJobs)) {
-		curJob = runJobs[jobIndex]
+	if 0 < jobIndex || jobIndex >= int64(len(runJobs)) {


Caused #34038, It should be jobIndex < 0. Fixed in #34041

Oh I didn't see this, my workflow that I tested was to short.

Sorry I made this typo. But why tests didn't catch it?

But why tests didn't catch it?

The reason was, this test only verifies that downloading a job log with index 0 downloads successfully.

Now this "bug" only appears for the second,third,nth job.

I have commented on the fix PR a patch to the test that expands the test to check, which I cannot push with my privilege here directly into that fix.

NikolayOG · 2025-04-12T16:54:14Z

Hi @lunny thank you for adding this feature. How can we obtain job_id in order to call this new API for downloading the job logs?

ChristopherHX · 2025-04-12T17:08:18Z

@NikolayOG workflow_job webhook id field (do not trust the url yet)

~~Eventually /repos/{owner}/{repo}/actions/tasks id field, not tested should provide you the id~~

NikolayOG · 2025-04-12T21:03:38Z

@NikolayOG workflow_job webhook id field (do not trust the url yet)

Eventually /repos/{owner}/{repo}/actions/tasks id field, not tested should provide you the id

I tried that but I think there is a bug. For what I have running (1.24.0+dev-572) when I query "api/v1/repos/nikg/test/actions/tasks" neither "id" nor "run_number" are 14, however, I am able to download some logs on "api/v1/repos/nikg/test/actions/jobs/14/logs" so there is some mismatch going on.

ChristopherHX · 2025-04-12T21:25:08Z

@NikolayOG I can confirm a mismatch, it's odd subtract one from the id...

workflow_job webhook reports the correct id, e.g. 1 + of the id field of the tasks endpoint

Need to debug to understand why and how.

I have plans to finish a rest api for workflow_job GitHub Style, but this might not make it in 1.24
EDIT typo I didn't meant now

ChristopherHX · 2025-04-12T21:31:52Z

Ok it's a different database id, sorry cannot be used.

Download actions logs from API

318d171

lunny added type/enhancement An improvement of existing functionality modifies/api This PR adds API routes or modifies them labels Mar 11, 2025

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 11, 2025

pull-request-size bot added the size/L label Mar 11, 2025

github-actions bot added the modifies/go Pull requests that update Go code label Mar 11, 2025

lunny added this to the 1.24.0 milestone Mar 11, 2025

Fix swagger

14b6ce7

lunny added 2 commits March 12, 2025 20:50

Merge branch 'main' into lunny/actions_log_api

3d45dc9

Add test for API actions log download

9ec87c7

wxiaoguang reviewed Mar 13, 2025

View reviewed changes

routers/api/v1/api.go Outdated Show resolved Hide resolved

wxiaoguang reviewed Mar 13, 2025

View reviewed changes

routers/api/v1/repo/actions_run.go Outdated Show resolved Hide resolved

wxiaoguang reviewed Mar 13, 2025

View reviewed changes

routers/api/v1/repo/actions_run.go Outdated Show resolved Hide resolved

ChristopherHX reviewed Mar 13, 2025

View reviewed changes

routers/api/v1/repo/actions_run.go Outdated Show resolved Hide resolved

lunny added 5 commits March 13, 2025 15:49

Extract actions log download function

5628233

Merge branch 'main' into lunny/actions_log_api

49f1d35

Update swagger documentation

bf5ccf8

Fix bug and test

75cab36

Merge branch 'main' into lunny/actions_log_api

24b215a

lunny added 2 commits March 17, 2025 12:15

Use job_id for the api endpoint

940bfe9

Merge branch 'main' into lunny/actions_log_api

e654bd0

lunny changed the title ~~Download actions logs from API~~ Download actions job logs from API Mar 17, 2025

lunny requested review from ChristopherHX and wxiaoguang March 17, 2025 19:20

Remove unused function

898ffff

ChristopherHX approved these changes Mar 17, 2025

View reviewed changes

routers/api/v1/repo/actions_run.go Outdated Show resolved Hide resolved

models/actions/run_job_list.go Outdated Show resolved Hide resolved

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 17, 2025

lunny and others added 5 commits March 17, 2025 13:05

Update routers/api/v1/repo/actions_run.go

470d05e

Co-authored-by: ChristopherHX <christopher.homberger@web.de>

Update models/actions/run_job_list.go

520e732

Co-authored-by: ChristopherHX <christopher.homberger@web.de>

Merge branch 'main' into lunny/actions_log_api

43208e4

Merge branch 'lunny/actions_log_api' of github.com:lunny/gitea into l…

b5d9696

…unny/actions_log_api

Fix lint

8cbf5f2

hiifong approved these changes Mar 26, 2025

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 26, 2025

wxiaoguang added 2 commits March 26, 2025 15:38

Merge branch 'main' into lunny/actions_log_api

1afd23d

fix

e712ff0

lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Mar 26, 2025

GiteaBot added 2 commits March 27, 2025 01:45

Merge branch 'main' into lunny/actions_log_api

08638a6

Merge branch 'main' into lunny/actions_log_api

8bb8e17

lunny merged commit 0c6957e into go-gitea:main Mar 26, 2025
26 checks passed

lunny deleted the lunny/actions_log_api branch March 26, 2025 18:30

GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Mar 26, 2025

Sirherobrine23 mentioned this pull request Mar 27, 2025

Fail to download actions logs #34038

Closed

lunny commented Mar 27, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Download actions job logs from API #33858

Download actions job logs from API #33858

lunny commented Mar 11, 2025 •

edited

Loading

wxiaoguang commented Mar 12, 2025

ChristopherHX commented Mar 16, 2025 •

edited

Loading

ChristopherHX commented Mar 16, 2025

lunny commented Mar 16, 2025

ChristopherHX commented Mar 16, 2025 •

edited

Loading

ChristopherHX left a comment

lunny Mar 27, 2025

ChristopherHX Mar 27, 2025

wxiaoguang Mar 27, 2025

ChristopherHX Mar 27, 2025

NikolayOG commented Apr 12, 2025

ChristopherHX commented Apr 12, 2025 •

edited

Loading

NikolayOG commented Apr 12, 2025 •

edited

Loading

ChristopherHX commented Apr 12, 2025 •

edited

Loading

This comment was marked as outdated.

ChristopherHX commented Apr 12, 2025

Download actions job logs from API #33858

Download actions job logs from API #33858

Conversation

lunny commented Mar 11, 2025 • edited Loading

wxiaoguang commented Mar 12, 2025

ChristopherHX commented Mar 16, 2025 • edited Loading

ChristopherHX commented Mar 16, 2025

lunny commented Mar 16, 2025

ChristopherHX commented Mar 16, 2025 • edited Loading

ChristopherHX left a comment

Choose a reason for hiding this comment

lunny Mar 27, 2025

Choose a reason for hiding this comment

ChristopherHX Mar 27, 2025

Choose a reason for hiding this comment

wxiaoguang Mar 27, 2025

Choose a reason for hiding this comment

ChristopherHX Mar 27, 2025

Choose a reason for hiding this comment

NikolayOG commented Apr 12, 2025

ChristopherHX commented Apr 12, 2025 • edited Loading

NikolayOG commented Apr 12, 2025 • edited Loading

ChristopherHX commented Apr 12, 2025 • edited Loading

This comment was marked as outdated.

ChristopherHX commented Apr 12, 2025

lunny commented Mar 11, 2025 •

edited

Loading

ChristopherHX commented Mar 16, 2025 •

edited

Loading

ChristopherHX commented Mar 16, 2025 •

edited

Loading

ChristopherHX commented Apr 12, 2025 •

edited

Loading

NikolayOG commented Apr 12, 2025 •

edited

Loading

ChristopherHX commented Apr 12, 2025 •

edited

Loading