Skip to content

feat: Add artifact and log retention period API support #3664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions github/actions_artifacts.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,21 @@ type ListArtifactsOptions struct {
ListOptions
}

// ArtifactPeriod represents the period for which the artifact and
// log of a workflow run is retained.
type ArtifactPeriod struct {
Days *int `json:"days,omitempty"`
MaximumAllowedDays *int `json:"maximum_allowed_days,omitempty"`
}

func (a ArtifactPeriod) String() string { return Stringify(a) }

// ArtifactPeriodOpt is used to specify the retention period of
// artifacts and logs in a workflow run.
type ArtifactPeriodOpt struct {
Days *int `json:"days,omitempty"`
}

// ListArtifacts lists all artifacts that belong to a repository.
//
// GitHub API docs: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
Expand Down
37 changes: 37 additions & 0 deletions github/actions_permissions_enterprise.go
Original file line number Diff line number Diff line change
Expand Up @@ -256,3 +256,40 @@ func (s *ActionsService) EditDefaultWorkflowPermissionsInEnterprise(ctx context.

return p, resp, nil
}

// GetArtifactAndLogRetentionPeriodInEnterprise gets the artifact and log retention period for an enterprise.
//
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise
//
//meta:operation GET /enterprises/{enterprise}/actions/permissions/artifact-and-log-retention
func (s *ActionsService) GetArtifactAndLogRetentionPeriodInEnterprise(ctx context.Context, enterprise string) (*ArtifactPeriod, *Response, error) {
u := fmt.Sprintf("enterprises/%v/actions/permissions/artifact-and-log-retention", enterprise)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

arp := new(ArtifactPeriod)
resp, err := s.client.Do(ctx, req, arp)
if err != nil {
return nil, resp, err
}

return arp, resp, nil
}

// EditArtifactAndLogRetentionPeriodInEnterprise sets the artifact and log retention period for an enterprise.
//
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise
//
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/artifact-and-log-retention
func (s *ActionsService) EditArtifactAndLogRetentionPeriodInEnterprise(ctx context.Context, enterprise string, period ArtifactPeriodOpt) (*Response, error) {
u := fmt.Sprintf("enterprises/%v/actions/permissions/artifact-and-log-retention", enterprise)
req, err := s.client.NewRequest("PUT", u, period)
if err != nil {
return nil, err
}

return s.client.Do(ctx, req, nil)
}
76 changes: 76 additions & 0 deletions github/actions_permissions_enterprise_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -375,3 +375,79 @@ func TestActionsService_EditDefaultWorkflowPermissionsInEnterprise(t *testing.T)
return resp, err
})
}

func TestActionsService_GetArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

mux.HandleFunc("/enterprises/e/actions/permissions/artifact-and-log-retention", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{"days": 90, "maximum_allowed_days": 365}`)
})

ctx := context.Background()
period, _, err := client.Actions.GetArtifactAndLogRetentionPeriodInEnterprise(ctx, "e")
if err != nil {
t.Errorf("Actions.GetArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
}

want := &ArtifactPeriod{
Days: Ptr(90),
MaximumAllowedDays: Ptr(365),
}
if !cmp.Equal(period, want) {
t.Errorf("Actions.GetArtifactAndLogRetentionPeriodInEnterprise = %+v, want %+v", period, want)
}

const methodName = "GetArtifactAndLogRetentionPeriodInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Actions.GetArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Actions.GetArtifactAndLogRetentionPeriodInEnterprise(ctx, "e")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}

func TestActionsService_EditArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := &ArtifactPeriodOpt{Days: Ptr(90)}

mux.HandleFunc("/enterprises/e/actions/permissions/artifact-and-log-retention", func(w http.ResponseWriter, r *http.Request) {
v := new(ArtifactPeriodOpt)
assertNilError(t, json.NewDecoder(r.Body).Decode(v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}
w.WriteHeader(http.StatusNoContent)
})

ctx := context.Background()
resp, err := client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
}

if resp.StatusCode != http.StatusNoContent {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
}

const methodName = "EditArtifactAndLogRetentionPeriodInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
})
}
37 changes: 37 additions & 0 deletions github/actions_permissions_orgs.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,3 +269,40 @@ func (s *ActionsService) EditDefaultWorkflowPermissionsInOrganization(ctx contex

return p, resp, nil
}

// GetArtifactAndLogRetentionPeriodInOrganization gets the artifact and log retention period for an organization.
//
// GitHub API docs: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization
//
//meta:operation GET /organizations/{org}/actions/permissions/artifact-and-log-retention
func (s *ActionsService) GetArtifactAndLogRetentionPeriodInOrganization(ctx context.Context, org string) (*ArtifactPeriod, *Response, error) {
u := fmt.Sprintf("organizations/%v/actions/permissions/artifact-and-log-retention", org)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

arp := new(ArtifactPeriod)
resp, err := s.client.Do(ctx, req, arp)
if err != nil {
return nil, resp, err
}

return arp, resp, nil
}

// EditArtifactAndLogRetentionPeriodInOrganization sets the artifact and log retention period for an organization.
//
// GitHub API docs: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization
//
//meta:operation PUT /organizations/{org}/actions/permissions/artifact-and-log-retention
func (s *ActionsService) EditArtifactAndLogRetentionPeriodInOrganization(ctx context.Context, org string, period ArtifactPeriodOpt) (*Response, error) {
u := fmt.Sprintf("organizations/%v/actions/permissions/artifact-and-log-retention", org)
req, err := s.client.NewRequest("PUT", u, period)
if err != nil {
return nil, err
}

return s.client.Do(ctx, req, nil)
}
76 changes: 76 additions & 0 deletions github/actions_permissions_orgs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -415,3 +415,79 @@ func TestActionsService_EditDefaultWorkflowPermissionsInOrganization(t *testing.
return resp, err
})
}

func TestActionsService_GetArtifactAndLogRetentionPeriodInOrganization(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

mux.HandleFunc("/organizations/o/actions/permissions/artifact-and-log-retention", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{"days": 90, "maximum_allowed_days": 365}`)
})

ctx := context.Background()
period, _, err := client.Actions.GetArtifactAndLogRetentionPeriodInOrganization(ctx, "o")
if err != nil {
t.Errorf("Actions.GetArtifactAndLogRetentionPeriodInOrganization returned error: %v", err)
}

want := &ArtifactPeriod{
Days: Ptr(90),
MaximumAllowedDays: Ptr(365),
}
if !cmp.Equal(period, want) {
t.Errorf("Actions.GetArtifactAndLogRetentionPeriodInOrganization = %+v, want %+v", period, want)
}

const methodName = "GetArtifactAndLogRetentionPeriodInOrganization"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Actions.GetArtifactAndLogRetentionPeriodInOrganization(ctx, "\n")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Actions.GetArtifactAndLogRetentionPeriodInOrganization(ctx, "o")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}

func TestActionsService_EditArtifactAndLogRetentionPeriodInOrganization(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := &ArtifactPeriodOpt{Days: Ptr(90)}

mux.HandleFunc("/organizations/o/actions/permissions/artifact-and-log-retention", func(w http.ResponseWriter, r *http.Request) {
v := new(ArtifactPeriodOpt)
assertNilError(t, json.NewDecoder(r.Body).Decode(v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}
w.WriteHeader(http.StatusNoContent)
})

ctx := context.Background()
resp, err := client.Actions.EditArtifactAndLogRetentionPeriodInOrganization(ctx, "o", *input)
if err != nil {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInOrganization returned error: %v", err)
}

if resp.StatusCode != http.StatusNoContent {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInOrganization = %d, want %d", resp.StatusCode, http.StatusNoContent)
}

const methodName = "EditArtifactAndLogRetentionPeriodInOrganization"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.EditArtifactAndLogRetentionPeriodInOrganization(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.EditArtifactAndLogRetentionPeriodInOrganization(ctx, "o", *input)
})
}
24 changes: 24 additions & 0 deletions github/github-accessors.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions github/github-accessors_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions github/github-stringify_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions github/repos_actions_permissions.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,40 @@ func (s *RepositoriesService) EditDefaultWorkflowPermissions(ctx context.Context

return p, resp, nil
}

// GetArtifactAndLogRetentionPeriod gets the artifact and log retention period for a repository.
//
// GitHub API docs: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
//
//meta:operation GET /repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention
func (s *RepositoriesService) GetArtifactAndLogRetentionPeriod(ctx context.Context, owner, repo string) (*ArtifactPeriod, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/actions/permissions/artifact-and-log-retention", owner, repo)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

arp := new(ArtifactPeriod)
resp, err := s.client.Do(ctx, req, arp)
if err != nil {
return nil, resp, err
}

return arp, resp, nil
}

// EditArtifactAndLogRetentionPeriod sets the artifact and log retention period for a repository.
//
// GitHub API docs: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
//
//meta:operation PUT /repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention
func (s *RepositoriesService) EditArtifactAndLogRetentionPeriod(ctx context.Context, owner, repo string, period ArtifactPeriodOpt) (*Response, error) {
u := fmt.Sprintf("repos/%v/%v/actions/permissions/artifact-and-log-retention", owner, repo)
req, err := s.client.NewRequest("PUT", u, period)
if err != nil {
return nil, err
}

return s.client.Do(ctx, req, nil)
}
Loading
Loading