TeamSettings

class TeamSettings : KotlinCustomResource

This resource manages the team settings (in particular the request review delegation settings) within the organization Creating this resource will alter the team Code Review settings. The team must both belong to the same organization configured in the provider on GitHub.

Note: This resource relies on the v4 GraphQl GitHub API. If this API is not available, or the Stone Crop schema preview is not available, then this resource will not work as intended.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.Team;
import com.pulumi.github.TeamArgs;
import com.pulumi.github.TeamSettings;
import com.pulumi.github.TeamSettingsArgs;
import com.pulumi.github.inputs.TeamSettingsReviewRequestDelegationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var someTeam = new Team("someTeam", TeamArgs.builder()
.description("Some cool team")
.build());
var codeReviewSettings = new TeamSettings("codeReviewSettings", TeamSettingsArgs.builder()
.teamId(someTeam.id())
.reviewRequestDelegation(TeamSettingsReviewRequestDelegationArgs.builder()
.algorithm("ROUND_ROBIN")
.memberCount(1)
.notify(true)
.build())
.build());
}
}

Import

GitHub Teams can be imported using the GitHub team ID, or the team slug e.g.

$ pulumi import github:index/teamSettings:TeamSettings code_review_settings 1234567

or,

$ pulumi import github:index/teamSettings:TeamSettings code_review_settings SomeTeam

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The settings for delegating code reviews to individuals on behalf of the team. If this block is present, even without any fields, then review request delegation will be enabled for the team. See GitHub Review Request Delegation below for details. See GitHub's documentation for more configuration details.

Link copied to clipboard
val teamId: Output<String>

The GitHub team id or the GitHub team slug

Link copied to clipboard
val teamSlug: Output<String>

The slug of the Team within the Organization.

Link copied to clipboard
val teamUid: Output<String>

The unique ID of the Team on GitHub. Corresponds to the ID of the 'github_team_settings' resource.

Link copied to clipboard
val urn: Output<String>