options.md

github options

• github.milestones
  type: list of submodules
  default: []
  example: [{"milestones":[{"state":"closed","title":"1.0"},{"title":"2.0"}],"owner":"terranix","repository":"terranix"}]
  defined: module/milestones.nix
  description: Define milestones. This parameter is a bit complicated because the terraform provider resource is a bit complicated designed. You have to create a list for each repository.
  
• github.milestones.*.milestones
  type: list of submodules
  default: []
  example: null
  defined: module/milestones.nix
  description: list of milestones for the given repository
  
• github.milestones.*.milestones.*.description
  type: null or string
  default: null
  example: null
  defined: module/milestones.nix
  description: description of the milestone
  
• github.milestones.*.milestones.*.due_date
  type: null or string
  default: null
  example: null
  defined: module/milestones.nix
  description: due date of the milestone. Format is yyyy-mm-dd.
  
• github.milestones.*.milestones.*.state
  type: null or one of "open", "closed"
  default: null
  example: null
  defined: module/milestones.nix
  description: state of the milestone
  
• github.milestones.*.milestones.*.title
  type: string
  default: null
  example: "1.0"
  defined: module/milestones.nix
  description: title of the milestone.
  
• github.milestones.*.owner
  type: string
  default: null
  example: null
  defined: module/milestones.nix
  description: owner of the repository. same value which you would put in github.provider.owner.
  
• github.milestones.*.repository
  type: string
  default: null
  example: null
  defined: module/milestones.nix
  description: name of the repository
  
• github.provider.base_url
  type: null or string
  default: null
  example: "https://terraformtesting-ghe.westus.cloudapp.azure.com/"
  defined: module/provider.nix
  description: This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the `GITHUB_BASE_URL` environment variable. The value must end with a slash.
  
• github.provider.enable
  type: boolean
  default: false
  example: true
  defined: module/provider.nix
  description: Whether to enable github.
  
• github.provider.owner
  type: null or string
  default: null
  example: null
  defined: module/provider.nix
  description: Organization or individual user account to manage. It is optional to provide this value and it can also be sourced from the `GITHUB_OWNER` environment variable. When not provided and a `github.provider.token` is available, the individual user account owning the token will be used. When not provided and no `token` is available, the provider may not function correctly
  
• github.provider.token
  type: null or string
  default: null
  example: null
  defined: module/provider.nix
  description: A GitHub OAuth or Personal Access Token. It can also be sourced from the `GITHUB_TOKEN` environment variable. hen not provided or made available via the `GITHUB_TOKEN` environment variable, the provider can only access resources available anonymously.
  
• github.provider.version
  type: null or string
  default: null
  example: null
  defined: module/provider.nix
  description: version of the github provider to use.
  
• github.repositories
  type: attribute set of submodules
  default: {}
  example: null
  defined: module/repositories.nix
  description: create and manage github repositories.
  
• github.repositories.<name>.allow_merge_commit
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to false to disable merge commits on the repository.
  
• github.repositories.<name>.allow_rebase_merge
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to false to disable rebase merges on the repository.
  
• github.repositories.<name>.allow_squash_merge
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to false to disable squash merges on the repository.
  
• github.repositories.<name>.archive_on_destroy
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to true to archive the repository instead of deleting on destroy.
  
• github.repositories.<name>.archived
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Specifies if the repository should be archived. Defaults to false
  
• github.repositories.<name>.auto_init
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to true to produce an initial commit in the repository.
  
• github.repositories.<name>.branches
  type: list of strings
  default: null
  example: ["main","develop"]
  defined: module/repositories.nix
  description: branches of repository
  
• github.repositories.<name>.colaborators
  type: attribute set of submodules
  default: {}
  example: ["main","develop"]
  defined: module/repositories.nix
  description: collaborators of repository
  
• github.repositories.<name>.colaborators.<name>.name
  type: string
  default: "‹name›"
  example: null
  defined: module/repositories.nix
  description: github name
  
• github.repositories.<name>.colaborators.<name>.permission
  type: null or one of "pull", "push", "maintain", "triage", "admin"
  default: null
  example: null
  defined: module/repositories.nix
  description: permissions of this collaborator
  
• github.repositories.<name>.default_branch
  type: null or string
  default: null
  example: "main"
  defined: module/repositories.nix
  description: default branch of the repository
  
• github.repositories.<name>.delete_branch_on_merge
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Automatically delete head branch after a pull request is merged. Defaults to false
  
• github.repositories.<name>.description
  type: null or string
  default: null
  example: null
  defined: module/repositories.nix
  description: description of the repository
  
• github.repositories.<name>.extraConfig
  type: attribute set
  default: {}
  example: null
  defined: module/repositories.nix
  description: To set additional parameters from https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository which are not covered yet. extraConfig will override every other parameter provider by this github terranix module.
  
• github.repositories.<name>.gitignore_template
  type: null or string
  default: null
  example: "Haskell"
  defined: module/repositories.nix
  description: Use the [name of the template](https://github.com/github/gitignore) without the extension.
  
• github.repositories.<name>.has_downloads
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to true to enable the (deprecated) downloads features on the repository.
  
• github.repositories.<name>.has_issues
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: should the repository have issue tracking
  
• github.repositories.<name>.has_projects
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: should the repository have projects
  
• github.repositories.<name>.has_wiki
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: should the repository have a wiki
  
• github.repositories.<name>.homepage_url
  type: null or string
  default: null
  example: null
  defined: module/repositories.nix
  description: homepage url of the repository
  
• github.repositories.<name>.is_template
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: is this repository a template
  
• github.repositories.<name>.license_template
  type: null or string
  default: null
  example: "mpl-2.0"
  defined: module/repositories.nix
  description: Use the [name of the template](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses) without the extension.
  
• github.repositories.<name>.name
  type: string
  default: "‹name›"
  example: null
  defined: module/repositories.nix
  description: name of the repository
  
• github.repositories.<name>.pages
  type: null or submodule
  default: null
  example: {"pages":{"source":{"branch":"gh-pages"}}}
  defined: module/repositories.nix
  description: The repository's GitHub Pages configuration.
  
• github.repositories.<name>.pages.cname
  type: null or string
  default: null
  example: null
  defined: module/repositories.nix
  description: The custom domain for the repository. This can only be set after the repository has been created.
  
• github.repositories.<name>.pages.source
  type: submodule
  default: null
  example: null
  defined: module/repositories.nix
  description: The source branch and directory for the rendered Pages site.
  
• github.repositories.<name>.pages.source.branch
  type: string
  default: null
  example: null
  defined: module/repositories.nix
  description: The repository branch used to publish the site's source files.
  
• github.repositories.<name>.pages.source.path
  type: null or string
  default: null
  example: null
  defined: module/repositories.nix
  description: The repository directory from which the site publishes
  
• github.repositories.<name>.teams
  type: attribute set of one of "pull", "triage", "push", "maintain", "admin"s
  default: {}
  example: null
  defined: module/repositories.nix
  description: list of teams this repository belongs to. convenience function, which appends this repository to github.teams;
  
• github.repositories.<name>.template
  type: null or submodule
  default: null
  example: null
  defined: module/repositories.nix
  description: Use a template repository to create this resource.
  
• github.repositories.<name>.template.owner
  type: string
  default: null
  example: null
  defined: module/repositories.nix
  description: The GitHub organization or user the template repository is owned by.
  
• github.repositories.<name>.template.repository
  type: string
  default: null
  example: null
  defined: module/repositories.nix
  description: The name of the template repository.
  
• github.repositories.<name>.topics
  type: list of strings
  default: []
  example: null
  defined: module/repositories.nix
  description: list of topics for the repository
  
• github.repositories.<name>.visibility
  type: null or one of "private", "public", "internal"
  default: null
  example: null
  defined: module/repositories.nix
  description: wether of the repository is private or not
  
• github.repositories.<name>.vulnerability_alerts
  type: null or boolean
  default: null
  example: null
  defined: module/repositories.nix
  description: Set to true to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level
  
• github.teams
  type: attribute set of submodules
  default: {}
  example: null
  defined: module/teams.nix
  description: create and manage github teams. You can use `github.repositories.<name>.teams` to append your managed repositores to a team.
  
• github.teams.<name>.description
  type: null or string
  default: null
  example: null
  defined: module/teams.nix
  description: description of the team.
  
• github.teams.<name>.extraConfig
  type: attribute set
  default: {}
  example: null
  defined: module/teams.nix
  description: To set additional parameters from https://registry.terraform.io/providers/integrations/github/latest/docs/resources/team which are not covered yet. extraConfig will override every other parameter provider by this github terranix module.
  
• github.teams.<name>.maintainers
  type: list of strings
  default: []
  example: ["mrvandalo"]
  defined: module/teams.nix
  description: maintainers of the team, have more permissions than members.
  
• github.teams.<name>.members
  type: list of strings
  default: []
  example: ["mrvandalo"]
  defined: module/teams.nix
  description: members of the team, have less permissions than maintainers.
  
• github.teams.<name>.name
  type: string
  default: "‹name›"
  example: null
  defined: module/teams.nix
  description: name of the team.
  
• github.teams.<name>.privacy
  type: null or one of "secret", "closed"
  default: null
  example: null
  defined: module/teams.nix
  description: secret means not visible for the public. closed means visible for the public.
  
• github.teams.<name>.repositories
  type: attribute set of one of "pull", "triage", "push", "maintain", "admin"s
  default: {}
  example: {"terranix":"pull","website":"maintain"}
  defined: module/teams.nix
  description: A list of Github repositories, belonging to this team. You can use `github.repositories.<name>.teams` alternatively to append you managed repository to a team.