Add Actions API endpoints for workflow run and job management #35382
+1,540
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GiteaBot
added
the
lgtm/need 2
github-actions
bot
added
modifies/api
|
Addresses #35176 |
|
Please be aware existing Gitea workflow api do not use runindex, also jobs use jobid instead of jobindex. GET /actions/runs/{run}/jobs/{job_id}/logs - Download job logs Line 1210 in d2f2221 |
Implements comprehensive REST API endpoints for GitHub Actions workflow runs:
- POST /actions/runs/{run}/rerun - Rerun entire workflow run
- POST /actions/runs/{run}/cancel - Cancel running workflow
- POST /actions/runs/{run}/approve - Approve workflow requiring approval
- POST /actions/runs/{run}/jobs/{job_id}/rerun - Rerun specific job
- GET /actions/runs/{run}/logs - Download run logs archive
- GET /actions/runs/{run}/jobs/{job_id}/logs - Download job logs
- POST /actions/runs/{run}/logs - Stream logs with cursor support
Features:
- Proper permission checks and workflow validation
- Support for "latest" run parameter
- Job dependency handling for reruns
- Streaming log API with cursor-based pagination
- Comprehensive test coverage
Fixes workflow management gaps in API compatibility.
…cate endpoint
Based on reviewer feedback, this commit makes the following changes:
## API Consistency Improvements
- Replace getRunIndex() with getRunID() to align with existing Gitea API patterns
- Update all endpoints to use run ID directly instead of run index
- Follow the same pattern as GetWorkflowRun(): runID := ctx.PathParamInt64("run") and db.GetByID[actions_model.ActionRun](ctx, runID)
- Update swagger documentation to reflect "run ID" instead of "run number"
## Remove Duplicate Endpoint
- Remove GetWorkflowJobLogs function and corresponding route /actions/runs/{run}/jobs/{job_id}/logs
- This eliminates duplication with existing /actions/jobs/{job_id}/logs endpoint
- Remove corresponding test TestAPIActionsGetWorkflowJobLogs
## Functions Updated
- RerunWorkflowRun: now uses run ID consistently
- CancelWorkflowRun: now uses run ID consistently
- ApproveWorkflowRun: now uses run ID consistently
- RerunWorkflowJob: now uses run ID consistently
- GetWorkflowRunLogs: now uses run ID consistently
- GetWorkflowRunLogsStream: now uses run ID consistently
## Helper Functions Refactored
- getRunIndex() → getRunID() with proper error handling
- getRunJobsByIndex() → getRunJobsByRunID() with proper validation
- getRunJobsAndCurrent() updated to use run ID parameter
All existing tests continue to pass as they were already using run IDs correctly.
rossigee
force-pushed
the
feature/runner-logs-api-endpoint
branch
from
d8ca88a to
f2cf2e6
Compare
|
Comments addressed. Please re-review. |
|
CI failure is still related. |
Implements comprehensive REST API endpoints for GitHub Actions workflow runs:
- POST /actions/runs/{run}/rerun - Rerun entire workflow run
- POST /actions/runs/{run}/cancel - Cancel running workflow
- POST /actions/runs/{run}/approve - Approve workflow requiring approval
- POST /actions/runs/{run}/jobs/{job_id}/rerun - Rerun specific job
- GET /actions/runs/{run}/logs - Download run logs archive
- GET /actions/runs/{run}/jobs/{job_id}/logs - Download job logs
- POST /actions/runs/{run}/logs - Stream logs with cursor support
Features:
- Proper permission checks and workflow validation
- Support for "latest" run parameter
- Job dependency handling for reruns
- Streaming log API with cursor-based pagination
- Comprehensive test coverage
Fixes workflow management gaps in API compatibility.
This commit adds comprehensive REST API endpoints for GitHub Actions workflow run and job operations, addressing requirements for: - Workflow run operations: approve, cancel, rerun - Job-specific operations: rerun individual jobs - Log streaming: both archive download and incremental streaming - Enhanced job log access with proper error handling Key changes: - Add 6 new API endpoints in actions_run.go using consistent run ID approach - Add comprehensive integration tests with proper error scenarios - Update Swagger documentation for all new endpoints - Maintain backward compatibility with existing API patterns All endpoints follow established authentication and authorization patterns, with proper error handling and response formatting.
- Keep GetWorkflowJobLogs function and grouped job endpoints - Use map[string]any consistently for modern Go style - Maintain all functionality from both branches
This commit adds comprehensive REST API endpoints for GitHub Actions workflow run and job operations, addressing requirements for: - Workflow run operations: approve, cancel, rerun - Job-specific operations: rerun individual jobs, download job logs - Log streaming: both archive download and incremental streaming - Enhanced job log access with proper error handling Key changes: - Add 6 new API endpoints in actions_run.go using consistent run ID approach - Add comprehensive integration tests with proper error scenarios - Update Swagger documentation for all new endpoints - Maintain backward compatibility with existing API patterns All endpoints follow established authentication and authorization patterns, with proper error handling and response formatting.
…e/gitea into feature/runner-logs-api-endpoint
The GetWorkflowJobLogs endpoint was incorrectly using DownloadActionsRunJobLogsWithIndex which expects a job index (0, 1, 2...) but we were passing a job ID (192). Fixed by: - Using GetRunJobByID to get the job by its actual ID - Using DownloadActionsRunJobLogs instead of the index-based version - Adding validation that the job belongs to the specified run This resolves the 404 'Job logs not found' error in CI tests.
- GetWorkflowRunLogs was only downloading logs for first job (index 0)
- GitHub Actions API expects workflow run logs to be a zip archive of all jobs
- Added DownloadActionsRunAllJobLogs function to create zip archive
- Each job's logs included as separate file: {workflow}-{jobname}-{taskid}.log
- Properly handles missing jobs, expired logs, and different repos
Fixes workflow run logs endpoint to match expected API behavior.
|
You seem to have messed up the PR diff, by not doing a merge. This is hard to read right now so I merge the branch via GitHub UI first |
| m.Post("/cancel", reqToken(), reqRepoWriter(unit.TypeActions), repo.CancelWorkflowRun) | ||
| m.Post("/approve", reqToken(), reqRepoWriter(unit.TypeActions), repo.ApproveWorkflowRun) | ||
| m.Get("/jobs", repo.ListWorkflowRunJobs) | ||
| m.Group("/jobs", func() { |
There was a problem hiding this comment.
We should move m.Get("/jobs", repo.ListWorkflowRunJobs)
as m.Get("", repo.ListWorkflowRunJobs) into m.Group("/jobs", func() {
Comment on lines
+1300
to
+1301
| m.Get("/logs", repo.GetWorkflowRunLogs) | ||
| m.Post("/logs", reqToken(), reqRepoReader(unit.TypeActions), repo.GetWorkflowRunLogsStream) |
There was a problem hiding this comment.
Use a group and define them with empty string inside the group
|
You might be using a wrong user account for tests, do they pass locally? EDIT fixed the malformed pasted markdown due to bugs in GitHub Comments Markdown pasting.... Do you need to help how to run these tests locally? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements comprehensive REST API endpoints for GitHub Actions workflow runs:
Features:
Fixes workflow management gaps in API compatibility.