// Copyright 2024 The Forgejo Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. // Copyright 2017 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package forgejo import ( "bytes" "encoding/json" "fmt" "net/url" "time" ) // StatusState holds the state of a Status // It can be "pending", "success", "error", "failure", and "warning" type StatusState string const ( // StatusPending is for when the Status is Pending StatusPending StatusState = "pending" // StatusSuccess is for when the Status is Success StatusSuccess StatusState = "success" // StatusError is for when the Status is Error StatusError StatusState = "error" // StatusFailure is for when the Status is Failure StatusFailure StatusState = "failure" // StatusWarning is for when the Status is Warning StatusWarning StatusState = "warning" ) // Status holds a single Status of a single Commit type Status struct { ID int64 `json:"id"` State StatusState `json:"status"` TargetURL string `json:"target_url"` Description string `json:"description"` URL string `json:"url"` Context string `json:"context"` Creator *User `json:"creator"` Created time.Time `json:"created_at"` Updated time.Time `json:"updated_at"` } // CreateStatusOption holds the information needed to create a new Status for a Commit type CreateStatusOption struct { State StatusState `json:"state"` TargetURL string `json:"target_url"` Description string `json:"description"` Context string `json:"context"` } // CreateStatus creates a new Status for a given Commit func (c *Client) CreateStatus(owner, repo, sha string, opts CreateStatusOption) (*Status, *Response, error) { if err := escapeValidatePathSegments(&owner, &repo); err != nil { return nil, nil, err } body, err := json.Marshal(&opts) if err != nil { return nil, nil, err } status := new(Status) resp, err := c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/statuses/%s", owner, repo, url.QueryEscape(sha)), jsonHeader, bytes.NewReader(body), status) return status, resp, err } // ListStatusesOption options for listing a repository's commit's statuses type ListStatusesOption struct { ListOptions } // ListStatuses returns all statuses for a given Commit by ref func (c *Client) ListStatuses(owner, repo, ref string, opt ListStatusesOption) ([]*Status, *Response, error) { if err := escapeValidatePathSegments(&owner, &repo, &ref); err != nil { return nil, nil, err } opt.setDefaults() statuses := make([]*Status, 0, opt.PageSize) resp, err := c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/commits/%s/statuses?%s", owner, repo, ref, opt.getURLQuery().Encode()), jsonHeader, nil, &statuses) return statuses, resp, err } // CombinedStatus holds the combined state of several statuses for a single commit type CombinedStatus struct { State StatusState `json:"state"` SHA string `json:"sha"` TotalCount int `json:"total_count"` Statuses []*Status `json:"statuses"` Repository *Repository `json:"repository"` CommitURL string `json:"commit_url"` URL string `json:"url"` } // GetCombinedStatus returns the CombinedStatus for a given Commit func (c *Client) GetCombinedStatus(owner, repo, ref string) (*CombinedStatus, *Response, error) { if err := escapeValidatePathSegments(&owner, &repo, &ref); err != nil { return nil, nil, err } status := new(CombinedStatus) resp, err := c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/commits/%s/status", owner, repo, ref), jsonHeader, nil, status) // forgejo api return empty body if nothing here jet if resp != nil && resp.StatusCode == 200 && err != nil { return status, resp, nil } return status, resp, err }