Skip to content
Open
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
16 changes: 16 additions & 0 deletions github/github-accessors.go

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

22 changes: 22 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.

82 changes: 82 additions & 0 deletions github/repos_immutable_releases.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
// Copyright 2026 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package github

import (
"context"
"fmt"
)

// RepoImmutableReleasesStatus represents the immutable releases status for a repository.
type RepoImmutableReleasesStatus struct {
Enabled *bool `json:"enabled,omitempty"`
EnforcedByOwner *bool `json:"enforced_by_owner,omitempty"`
}

// EnableImmutableReleases enables immutable releases for a repository.
//
// GitHub API docs: https://docs.github.com/rest/repos/repos#enable-immutable-releases
//
//meta:operation PUT /repos/{owner}/{repo}/immutable-releases
func (s *RepositoriesService) EnableImmutableReleases(ctx context.Context, owner, repo string) (*Response, error) {
u := fmt.Sprintf("repos/%v/%v/immutable-releases", owner, repo)

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

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

return resp, nil
}

// DisableImmutableReleases disables immutable releases for a repository.
//
// GitHub API docs: https://docs.github.com/rest/repos/repos#disable-immutable-releases
//
//meta:operation DELETE /repos/{owner}/{repo}/immutable-releases
func (s *RepositoriesService) DisableImmutableReleases(ctx context.Context, owner, repo string) (*Response, error) {
u := fmt.Sprintf("repos/%v/%v/immutable-releases", owner, repo)

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

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

return resp, nil
}

// IsImmutableReleasesEnabled checks if immutable releases are enabled for
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please rename this method so that it reads better in English?

Suggested change
// IsImmutableReleasesEnabled checks if immutable releases are enabled for
// AreImmutableReleasesEnabled checks if immutable releases are enabled for

// the repository.
//
// GitHub API docs: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
//
//meta:operation GET /repos/{owner}/{repo}/immutable-releases
func (s *RepositoriesService) IsImmutableReleasesEnabled(ctx context.Context, owner, repo string) (*RepoImmutableReleasesStatus, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/immutable-releases", owner, repo)

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

status := new(RepoImmutableReleasesStatus)
resp, err := s.client.Do(ctx, req, status)
Comment on lines +75 to +76
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please use this more idiomatic Go pattern?
I really dislike the use of new when it can easily be avoided by taking advantage of the zero-value.

Suggested change
status := new(RepoImmutableReleasesStatus)
resp, err := s.client.Do(ctx, req, status)
var status *RepoImmutableReleasesStatus
resp, err := s.client.Do(ctx, req, &status)

if err != nil {
return nil, resp, err
}

return status, resp, nil
}
100 changes: 100 additions & 0 deletions github/repos_immutable_releases_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Copyright 2026 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package github

import (
"fmt"
"net/http"
"testing"

"github.com/google/go-cmp/cmp"
)

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

mux.HandleFunc("/repos/owner/repo/immutable-releases", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
w.WriteHeader(http.StatusNoContent)
})

ctx := t.Context()
_, err := client.Repositories.EnableImmutableReleases(ctx, "owner", "repo")
if err != nil {
t.Errorf("Repositories.EnableImmutableReleases returned error: %v", err)
}

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

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Repositories.EnableImmutableReleases(ctx, "owner", "repo")
})
}

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

mux.HandleFunc("/repos/owner/repo/immutable-releases", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "DELETE")
w.WriteHeader(http.StatusNoContent)
})

ctx := t.Context()
_, err := client.Repositories.DisableImmutableReleases(ctx, "owner", "repo")
if err != nil {
t.Errorf("Repositories.DisableImmutableReleases returned error: %v", err)
}

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

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Repositories.DisableImmutableReleases(ctx, "owner", "repo")
})
}

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

mux.HandleFunc("/repos/owner/repo/immutable-releases", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{"enabled": true, "enforced_by_owner": false}`)
})

ctx := t.Context()
status, _, err := client.Repositories.IsImmutableReleasesEnabled(ctx, "owner", "repo")
if err != nil {
t.Errorf("Repositories.IsImmutableReleasesEnabled returned error: %v", err)
}
want := &RepoImmutableReleasesStatus{Enabled: Ptr(true), EnforcedByOwner: Ptr(false)}
if !cmp.Equal(status, want) {
t.Errorf("Repositories.IsImmutableReleasesEnabled returned %+v, want %+v", status, want)
}

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

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Repositories.IsImmutableReleasesEnabled(ctx, "owner", "repo")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}
Loading