GithubOrganizationArgs

interface GithubOrganizationArgs extends module:@jobcloud/github-organization.GithubOrganizationIdentityArgs {
githubTeams: Record<string, Omit<GithubOrganizationTeamArgs, 'name'>>;
githubUsers: Record<string, Omit<GithubOrganizationUserArgs, 'accountName'>>;
identity: string;
repositoryCollaborators?: Record<string, Omit<GithubOrganizationRepositoryCollaboratorArgs, 'accountName' | 'repository'>>;
}

Input arguments for GithubOrganization.

Example

CODE

const args: GithubOrganizationArgs = {
  identity: 'governance',
  githubTeams: { 'platform-engineering': {} },
  githubUsers: { alice: { email: 'alice@example.com', teams: ['platform-engineering'] } },
  repositoryCollaborators: { 'jobcloud/infrastructure::external-contractor': { email: 'contractor@example.com' } },
};

Hierarchy

GithubOrganizationIdentityArgs
GithubOrganizationArgs

Properties

`githubTeams: Record<string, Omit<GithubOrganizationTeamArgs, 'name'>>`

Teams keyed by their GitHub team name.

`githubUsers: Record<string, Omit<GithubOrganizationUserArgs, 'accountName'>>`

Organisation members keyed by their GitHub account name.

`identity: string`

Inherited from identity

Stable identity segment used to derive the component logical name.

Remarks

This value derives the Pulumi logical name for the component, must be a plain non-empty synchronous string (not a pulumi.Input, pulumi.Output, or promise-derived value), must contain characters that survive sanitisation to a non-empty segment, and should remain stable for the lifetime of the component instance because changing it changes the logical name and forces replacement.

`repositoryCollaborators: Record<string, Omit<GithubOrganizationRepositoryCollaboratorArgs, 'accountName' | 'repository'>>`

Repository collaborators keyed as <repository>::<accountName>.