Skip to content

Team

Definition of an organization Team, the following properties are supported:

Key Value Description Note
name string The name of the team
description string The description of the team
privacy string The level of privacy this team should have visible or secret
notifications boolean Whether the team members receive notifications when the team is @mentioned
members list[string] List of users that should be a member of the team
skip_members boolean If true, team members will be ignored
skip_non_organization_members boolean If true, users which are not yet organization members can not be added to the team

Jsonnet Function

orgs.newTeam('<name>') {
  <key>: <value>
}

Validation rules

  • setting privacy must be one of visible or secret, any other value triggers an error
  • specifying a non-empty list of members while skip_members is enabled, triggers an error
  • specifying a user in members that is not yet an organization member while skip_non_organization_members is enabled, triggers an error

Example usage

orgs.newOrg('OtterdogTest') {
  ...
  teams+: [
    orgs.newTeam('committers') {
      description: "The project committers",
      privacy: "visible",
    },
  ],
  ...
}