github.com/google/go-github/v57@v57.0.0/github/repos_actions_permissions.go (about)

     1  // Copyright 2022 The go-github AUTHORS. All rights reserved.
     2  //
     3  // Use of this source code is governed by a BSD-style
     4  // license that can be found in the LICENSE file.
     5  
     6  package github
     7  
     8  import (
     9  	"context"
    10  	"fmt"
    11  )
    12  
    13  // ActionsPermissionsRepository represents a policy for repositories and allowed actions in a repository.
    14  //
    15  // GitHub API docs: https://docs.github.com/rest/actions/permissions
    16  type ActionsPermissionsRepository struct {
    17  	Enabled            *bool   `json:"enabled,omitempty"`
    18  	AllowedActions     *string `json:"allowed_actions,omitempty"`
    19  	SelectedActionsURL *string `json:"selected_actions_url,omitempty"`
    20  }
    21  
    22  func (a ActionsPermissionsRepository) String() string {
    23  	return Stringify(a)
    24  }
    25  
    26  // GetActionsPermissions gets the GitHub Actions permissions policy for repositories and allowed actions in a repository.
    27  //
    28  // GitHub API docs: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
    29  //
    30  //meta:operation GET /repos/{owner}/{repo}/actions/permissions
    31  func (s *RepositoriesService) GetActionsPermissions(ctx context.Context, owner, repo string) (*ActionsPermissionsRepository, *Response, error) {
    32  	u := fmt.Sprintf("repos/%v/%v/actions/permissions", owner, repo)
    33  	req, err := s.client.NewRequest("GET", u, nil)
    34  	if err != nil {
    35  		return nil, nil, err
    36  	}
    37  
    38  	permissions := new(ActionsPermissionsRepository)
    39  	resp, err := s.client.Do(ctx, req, permissions)
    40  	if err != nil {
    41  		return nil, resp, err
    42  	}
    43  
    44  	return permissions, resp, nil
    45  }
    46  
    47  // EditActionsPermissions sets the permissions policy for repositories and allowed actions in a repository.
    48  //
    49  // GitHub API docs: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
    50  //
    51  //meta:operation PUT /repos/{owner}/{repo}/actions/permissions
    52  func (s *RepositoriesService) EditActionsPermissions(ctx context.Context, owner, repo string, actionsPermissionsRepository ActionsPermissionsRepository) (*ActionsPermissionsRepository, *Response, error) {
    53  	u := fmt.Sprintf("repos/%v/%v/actions/permissions", owner, repo)
    54  	req, err := s.client.NewRequest("PUT", u, actionsPermissionsRepository)
    55  	if err != nil {
    56  		return nil, nil, err
    57  	}
    58  
    59  	permissions := new(ActionsPermissionsRepository)
    60  	resp, err := s.client.Do(ctx, req, permissions)
    61  	if err != nil {
    62  		return nil, resp, err
    63  	}
    64  
    65  	return permissions, resp, nil
    66  }