mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-03-25 08:53:04 -04:00
120f97a914
Expose the attempt number of `ActionRunJob` in the HTTP API. It is required to uniquely identify a job run. Example: ``` $ curl -u andreas --basic http://192.168.178.62:3000/api/v1/repos/andreas/test/actions/runners/jobs ``` ```json [{"id":63,"attempt":2,"repo_id":1,"owner_id":1,"name":"test","needs":null,"runs_on":["debian"],"task_id":0,"status":"waiting"}] ``` ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. 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... - [ ] 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/11687 Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org> Co-authored-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch> Co-committed-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
88 lines
3 KiB
Go
88 lines
3 KiB
Go
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package structs
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
// ActionRunJob represents a job of a run
|
|
// swagger:model
|
|
type ActionRunJob struct {
|
|
// Identifier of this job.
|
|
ID int64 `json:"id"`
|
|
// How many times the job has been attempted including the current attempt.
|
|
Attempt int64 `json:"attempt"`
|
|
// the repository id
|
|
RepoID int64 `json:"repo_id"`
|
|
// the owner id
|
|
OwnerID int64 `json:"owner_id"`
|
|
// the action run job name
|
|
Name string `json:"name"`
|
|
// the action run job needed ids
|
|
Needs []string `json:"needs"`
|
|
// the action run job labels to run on
|
|
RunsOn []string `json:"runs_on"`
|
|
// the action run job latest task id
|
|
TaskID int64 `json:"task_id"`
|
|
// the action run job status
|
|
Status string `json:"status"`
|
|
}
|
|
|
|
// ActionRun represents an action run
|
|
// swagger:model
|
|
type ActionRun struct {
|
|
// the action run id
|
|
ID int64 `json:"id"`
|
|
// the action run's title
|
|
Title string `json:"title"`
|
|
// the repo this action is part of
|
|
Repo *Repository `json:"repository"`
|
|
// the name of workflow file
|
|
WorkflowID string `json:"workflow_id"`
|
|
// a unique number for each run of a repository
|
|
Index int64 `json:"index_in_repo"`
|
|
// the user that triggered this action run
|
|
TriggerUser *User `json:"trigger_user"`
|
|
// the cron id for the schedule trigger
|
|
ScheduleID int64
|
|
// the commit/tag/… the action run ran on
|
|
PrettyRef string `json:"prettyref"`
|
|
// has the commit/tag/… the action run ran on been deleted
|
|
IsRefDeleted bool `json:"is_ref_deleted"`
|
|
// the commit sha the action run ran on
|
|
CommitSHA string `json:"commit_sha"`
|
|
// If this is triggered by a PR from a forked repository or an untrusted user, we need to check if it is approved and limit permissions when running the workflow.
|
|
IsForkPullRequest bool `json:"is_fork_pull_request"`
|
|
// may need approval if it's a fork pull request
|
|
NeedApproval bool `json:"need_approval"`
|
|
// who approved this action run
|
|
ApprovedBy int64 `json:"approved_by"`
|
|
// the webhook event that causes the workflow to run
|
|
Event string `json:"event"`
|
|
// the payload of the webhook event that causes the workflow to run
|
|
EventPayload string `json:"event_payload"`
|
|
// the trigger event defined in the `on` configuration of the triggered workflow
|
|
TriggerEvent string `json:"trigger_event"`
|
|
// the current status of this run
|
|
Status string `json:"status"`
|
|
// when the action run was started
|
|
Started time.Time `json:"started,omitempty"`
|
|
// when the action run was stopped
|
|
Stopped time.Time `json:"stopped,omitempty"`
|
|
// when the action run was created
|
|
Created time.Time `json:"created,omitempty"`
|
|
// when the action run was last updated
|
|
Updated time.Time `json:"updated,omitempty"`
|
|
// how long the action run ran for
|
|
Duration time.Duration `json:"duration,omitempty"`
|
|
// the url of this action run
|
|
HTMLURL string `json:"html_url"`
|
|
}
|
|
|
|
// ListActionRunResponse return a list of ActionRun
|
|
type ListActionRunResponse struct {
|
|
Entries []*ActionRun `json:"workflow_runs"`
|
|
TotalCount int64 `json:"total_count"`
|
|
}
|