🔒 Managing GitHub repos in a compliant way just got way easier.

One of the most common requirements for companies operating in regulated spaces is having consistent, enforceable repository configurations. Some teams have hacked together homegrown solutions, while others know it's something they need to do but never quite got to.

Our aws-github-repository component changes that by providing comprehensive GitHub repository management entirely through infrastructure as code.

Manage repos and all settings declaratively:

• Repository configuration (visibility, topics, features, merge settings)
• Environments with deployment protection and reviewers
• Variables and secrets pulling from AWS Secrets Manager and Parameter Store
• Branch protection rules and rule sets
• Webhooks, deploy keys, labels, and custom properties
• Team and user permissions

Import existing repos and bring them under management:

• Import existing repositories and their configurations
• Bring legacy repos under consistent management
• Maintain existing settings while adding compliance controls

Define repository archetypes once:

• Create abstract components for common configurations
• Use Atmos inheritance to automatically apply baseline compliance
• Every new repo inherits your security and compliance standards
• DRY up infrastructure with reusable templates

All powered by Atmos + a GitHub App for secure, auditable rollout across your organization.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Regional

This component provides comprehensive GitHub repository management with support for advanced features like environments, webhooks, deploy keys, custom properties, and more.

Basic Usage

Here's a simple example for creating a basic repository:

components:
  terraform:
    my-basic-repo:
      vars:
        enabled: true
        owner: "my-organization"
        repository:
          name: "my-basic-repo"
          description: "A basic repository with standard settings"
          homepage_url: "https://github.com/my-organization/my-basic-repo"
          visibility: "private"
          default_branch: "main"
          topics:
            - terraform
            - github
            - infrastructure
        teams:
          devops: admin
          developers: push
        variables:
          ENVIRONMENT: "production"
          REGION: "us-east-1"
        secrets:
          AWS_ACCESS_KEY_ID: "nacl:dGVzdC1hY2Nlc3Mta2V5LWlkCg=="
          DATABASE_URL: "ssm:///my-basic-repo/database-url"

Advanced Usage with Atmos Inheritance and Imports

The component supports Atmos inheritance and imports to create DRY (Don't Repeat Yourself) configurations. This allows you to define common settings once and reuse them across multiple repositories.

Tip

For complete working examples of inheritance and imports, see the /examples folder in this repository.

Creating Abstract Components

First, create abstract components that define common configurations:

# catalog/github/repo/defaults.yaml
components:
  terraform:
    github/repo/defaults:
      metadata:
        component: github-repository
        type: abstract
      vars:
        enabled: true

        # Common team permissions
        teams:
          devops: admin

        # Default repository settings
        repository:
          homepage_url: "https://github.com/{{ .vars.owner }}/{{ .vars.repository.name }}"
          topics:
            - terraform
            - github
          default_branch: "main"
          visibility: "private"

          # Common features
          auto_init: true
          gitignore_template: "TeX"
          license_template: "GPL-3.0"

          # Merge settings
          allow_merge_commit: true
          allow_squash_merge: true
          allow_rebase_merge: true
          allow_auto_merge: true

          # Branch protection
          delete_branch_on_merge: true
          web_commit_signoff_required: true

Creating a Master Defaults Component

Combine abstract components into a master defaults component:

# catalog/github/defaults.yaml
import:
  - catalog/github/repo/*
  - catalog/github/environment/*
  - catalog/github/ruleset/*

components:
  terraform:
    github/defaults:
      metadata:
        type: abstract
        inherits:
          - github/repo/defaults
          - github/ruleset/branch-protection
          - github/environment/defaults

Using Inheritance in Your Stacks

Now you can create repositories that inherit from these defaults:

# orgs/mycompany/myteam.yaml
import:
  - ./_defaults
  - catalog/github/defaults

components:
  terraform:
    # Simple repository inheriting all defaults
    my-simple-app:
      metadata:
        component: github-repository
        inherits:
          - github/defaults
      vars:
        repository:
          name: my-simple-app
          description: "My simple application"
          topics:
            - application
            - nodejs

    # Repository with custom overrides
    my-custom-app:
      metadata:
        component: github-repository
        inherits:
          - github/defaults
      vars:
        repository:
          name: my-custom-app
          description: "My custom application"
          topics:
            - application
            - python
            - api
        # Override default team permissions
        teams:
          devops: admin
          backend: push
          frontend: push
        # Add custom variables and secrets
        variables:
          LANGUAGE: "python"
          FRAMEWORK: "fastapi"
        secrets:
          PYTHON_API_KEY: "asm://my-custom-app-api-key"

Secrets and Variables Management

The component supports setting repository and environment secrets and variables. Secrets and variables can be set using the following methods:

• Raw values (unencrypted string) (example: my-secret-value)
• AWS Secrets Manager (SM) (example: asm://secret-name)
• AWS Systems Manager Parameter Store (SSM) (example: ssm:///my/secret/path)

In addition to that secrets supports base64 encoded values encrypted with repository key. The value should be prefixed with nacl: (example: nacl:dGVzdC12YWx1ZS0yCg==).

Environment-Specific Secrets and Variables

environments:
  production:
    variables:
      ENVIRONMENT: "production"
      CLUSTER_NAME: "prod-cluster"
      LOG_LEVEL: "warn"
    secrets:
      PROD_DATABASE_URL: "ssm:///my-repo/prod/database-url"
      PROD_API_KEY: "asm://my-repo-prod-api-key"
      PROD_JWT_SECRET: "nacl:cHJvZC1qd3Qtc2VjcmV0Cg=="

  staging:
    variables:
      ENVIRONMENT: "staging"
      CLUSTER_NAME: "staging-cluster"
      LOG_LEVEL: "info"
    secrets:
      STAGING_DATABASE_URL: "ssm:///my-repo/staging/database-url"
      STAGING_API_KEY: "asm://my-repo-staging-api-key"

Import Mode

The component supports importing existing repository and its configurations:

• collaborators
• variables
• environments
• environment variables
• labels
• custom properties values
• autolink references
• deploy keys

Import mode is enabled by setting import input variable to true.

components:
  terraform:
    my-imported-repo:
      vars:
        enabled: true
        import: true
        owner: "my-organization"
        repository:
          name: "existing-repo-to-import"

The following configurations are not supported for import:

• secrets
• environment secrets
• branch protection policies
• rulesets

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name	Version
terraform	>= 1.7.0
aws	>= 5.0.0
github	>= 6.6.0

Providers

Name	Version
aws	>= 5.0.0
github	>= 6.6.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
repository	cloudposse/repository/github	1.1.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_secretsmanager_secret.default	data source
aws_secretsmanager_secret_version.default	data source
aws_ssm_parameter.default	data source
github_actions_environment_variables.default	data source
github_actions_variables.default	data source
github_issue_labels.default	data source
github_repository.default	data source
github_repository_autolink_references.default	data source
github_repository_custom_properties.default	data source
github_repository_deploy_keys.default	data source
github_repository_environments.default	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
autolink_references	Autolink references	map(object({ key_prefix = string target_url_template = string is_alphanumeric = optional(bool, false) }))	{}	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
custom_properties	Custom properties for the repository	map(object({ string = optional(string, null) boolean = optional(bool, null) single_select = optional(string, null) multi_select = optional(list(string), null) }))	{}	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
deploy_keys	Deploy keys for the repository	map(object({ title = string key = string read_only = optional(bool, false) }))	{}	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
environments	Environments for the repository. Enviroment secrets should be encrypted using the GitHub public key in Base64 format if prefixed with nacl:. Read more: https://docs.github.com/en/actions/security-for-github-actions/encrypted-secrets	map(object({ wait_timer = optional(number, 0) can_admins_bypass = optional(bool, false) prevent_self_review = optional(bool, false) reviewers = optional(object({ teams = optional(list(string), []) users = optional(list(string), []) }), null) deployment_branch_policy = optional(object({ protected_branches = optional(bool, false) custom_branches = optional(object({ branches = optional(list(string), null) tags = optional(list(string), null) }), null) }), null) variables = optional(map(string), null) secrets = optional(map(string), null) }))	{}	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
import	Import repository	bool	false	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels	A map of labels to configure for the repository	map(object({ color = string description = string }))	{}	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
owner	Owner of the repository	string	n/a	yes
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
region	AWS Region	string	n/a	yes
repository	Repository configuration	object({ name = string description = optional(string, null) visibility = optional(string, "public") homepage_url = optional(string, null) archived = optional(bool, false) has_issues = optional(bool, false) has_projects = optional(bool, false) has_discussions = optional(bool, false) has_wiki = optional(bool, false) has_downloads = optional(bool, false) is_template = optional(bool, false) allow_auto_merge = optional(bool, false) allow_squash_merge = optional(bool, true) squash_merge_commit_title = optional(string, "PR_TITLE") squash_merge_commit_message = optional(string, "PR_BODY") allow_merge_commit = optional(bool, true) merge_commit_title = optional(string, "PR_TITLE") merge_commit_message = optional(string, "PR_BODY") allow_rebase_merge = optional(bool, true) delete_branch_on_merge = optional(bool, false) default_branch = optional(string, "main") web_commit_signoff_required = optional(bool, false) topics = optional(list(string), []) license_template = optional(string, null) gitignore_template = optional(string, null) auto_init = optional(bool, false) ignore_vulnerability_alerts_during_read = optional(bool, false) enable_vulnerability_alerts = optional(bool, true) allow_update_branch = optional(bool, false) security_and_analysis = optional(object({ advanced_security = bool secret_scanning = bool secret_scanning_push_protection = bool }), null) archive_on_destroy = optional(bool, false) })	n/a	yes
rulesets	A map of rulesets to configure for the repository	map(object({ name = string # disabled, active enforcement = string # branch, tag target = string bypass_actors = optional(list(object({ # always, pull_request bypass_mode = string actor_id = optional(string, null) # RepositoryRole, Team, Integration, OrganizationAdmin actor_type = string })), []) conditions = object({ ref_name = object({ # Supports ~DEFAULT_BRANCH or ~ALL include = optional(list(string), []) exclude = optional(list(string), []) }) }) rules = object({ branch_name_pattern = optional(object({ # starts_with, ends_with, contains, regex operator = string pattern = string name = optional(string, null) negate = optional(bool, false) }), null), commit_author_email_pattern = optional(object({ # starts_with, ends_with, contains, regex operator = string pattern = string name = optional(string, null) negate = optional(bool, false) }), null), creation = optional(bool, false), deletion = optional(bool, false), non_fast_forward = optional(bool, false), required_pull_request_reviews = optional(object({ dismiss_stale_reviews = bool required_approving_review_count = number }), null), commit_message_pattern = optional(object({ # starts_with, ends_with, contains, regex operator = string pattern = string name = optional(string, null) negate = optional(bool, false) }), null), committer_email_pattern = optional(object({ # starts_with, ends_with, contains, regex operator = string pattern = string name = optional(string, null) negate = optional(bool, false) }), null), merge_queue = optional(object({ check_response_timeout_minutes = optional(number, 60) # ALLGREEN, HEADGREEN grouping_strategy = string max_entries_to_build = optional(number, 5) max_entries_to_merge = optional(number, 5) # MERGE, SQUASH, REBASE merge_method = optional(string, "MERGE") min_entries_to_merge = optional(number, 1) min_entries_to_merge_wait_minutes = optional(number, 5) }), null), pull_request = optional(object({ dismiss_stale_reviews_on_push = optional(bool, false) require_code_owner_review = optional(bool, false) require_last_push_approval = optional(bool, false) required_approving_review_count = optional(number, 0) required_review_thread_resolution = optional(bool, false) }), null), required_deployments = optional(object({ required_deployment_environments = optional(list(string), []) }), null), required_status_checks = optional(object({ required_check = list(object({ context = string integration_id = optional(number, null) })) strict_required_status_checks_policy = optional(bool, false) do_not_enforce_on_create = optional(bool, false) }), null), tag_name_pattern = optional(object({ # starts_with, ends_with, contains, regex operator = string pattern = string name = optional(string, null) negate = optional(bool, false) }), null), # Unsupported due to drift. # integrations/terraform-provider-github#2701 # required_code_scanning = optional(object({ # required_code_scanning_tool = list(object({ # // none, errors, errors_and_warnings, all # alerts_threshold = string # // none, critical, high_or_higher, medium_or_higher, all # security_alerts_threshold = string # tool = string # })) # }), null), }), }))	{}	no
secrets	Secrets for the repository (if prefixed with nacl: it should be encrypted value using the GitHub public key in Base64 format. Read more: https://docs.github.com/en/actions/security-for-github-actions/encrypted-secrets)	map(string)	{}	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
teams	A map of teams and their permissions for the repository	map(string)	{}	no
template	Template repository	object({ owner = string name = string include_all_branches = optional(bool, false) })	null	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
users	A map of users and their permissions for the repository	map(string)	{}	no
variables	Environment variables for the repository	map(string)	{}	no
webhooks	A map of webhooks to configure for the repository	map(object({ active = optional(bool, true) events = list(string) url = string content_type = optional(string, "json") insecure_ssl = optional(bool, false) secret = optional(string, null) }))	{}	no

Outputs

Name	Description
collaborators_invitation_ids	Collaborators invitation IDs
full_name	Full name of the created repository
git_clone_url	Git clone URL of the created repository
html_url	HTML URL of the created repository
http_clone_url	HTTP clone URL of the created repository
node_id	Node ID of the created repository
primary_language	Primary language of the created repository
repo_id	Repository ID of the created repository
rulesets_etags	Rulesets etags
rulesets_node_ids	Rulesets node IDs
rulesets_rules_ids	Rulesets rules IDs
ssh_clone_url	SSH clone URL of the created repository
svn_url	SVN URL of the created repository
webhooks_urls	Webhooks URLs

Related Projects

Check out these related projects.

• Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
• Atmos - Atmos is like docker-compose but for your infrastructure

References

For additional context, refer to some of these links.

• Cloud Posse Documentation - Complete documentation for the Cloud Posse solution
• Reference Architectures - Launch effortlessly with our turnkey reference architectures, built either by your team or ours.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

• Install Atmos (installation guide)
• Install Go 1.24+ or newer
• Install Terraform or OpenTofu

To run tests:

• Run all tests:

  atmos test run

• Clean up test artifacts:

  atmos test clean

• Explore additional test options:

  atmos test --help

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2026 Cloud Posse, LLC