Team
Provides a GitHub team resource. This resource allows you to add/remove teams from your organization. When applied, a new team will be created. When destroyed, that team will be removed.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
// Add a team to the organization
const someTeam = new github.Team("some_team", {
name: "some-team",
description: "Some cool team",
privacy: "closed",
});
Content copied to clipboard
import pulumi
import pulumi_github as github
# Add a team to the organization
some_team = github.Team("some_team",
name="some-team",
description="Some cool team",
privacy="closed")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
// Add a team to the organization
var someTeam = new Github.Team("some_team", new()
{
Name = "some-team",
Description = "Some cool team",
Privacy = "closed",
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Add a team to the organization
_, err := github.NewTeam(ctx, "some_team", &github.TeamArgs{
Name: pulumi.String("some-team"),
Description: pulumi.String("Some cool team"),
Privacy: pulumi.String("closed"),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
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 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) {
// Add a team to the organization
var someTeam = new Team("someTeam", TeamArgs.builder()
.name("some-team")
.description("Some cool team")
.privacy("closed")
.build());
}
}
Content copied to clipboard
resources:
# Add a team to the organization
someTeam:
type: github:Team
name: some_team
properties:
name: some-team
description: Some cool team
privacy: closed
Content copied to clipboard
Import
GitHub Teams can be imported using the GitHub team ID or name e.g.
$ pulumi import github:index/team:Team core 1234567
Content copied to clipboard
$ pulumi import github:index/team:Team core Administrators
Content copied to clipboard
Properties
Link copied to clipboard
Adds a default maintainer to the team. Defaults to false
and adds the creating user to the team when true
.
Link copied to clipboard
A description of the team.
Link copied to clipboard
Link copied to clipboard
The ID or slug of the parent team, if this is a nested team.
Link copied to clipboard
The id of the parent team read in Github.
Link copied to clipboard
The id of the parent team read in Github.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
The slug of the created team, which may or may not differ from name
, depending on whether name
contains "URL-unsafe" characters. Useful when referencing the team in github.BranchProtection
.