Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
Manages GitHub repository settings and branch/tag protection for the
`tailrocks` organization: 46 repositories, each with repository merge
settings plus `protect-main` and `protect-tags` rulesets, and optional
per-repository tag-creation rulesets.
per-repository tag-creation rulesets. Two exceptions: archived repositories
(`archived = true`) get no managed settings, because GitHub refuses changes to
them, and private repositories get no rulesets, because the free plan returns
403 for them.

## Layout

Expand Down Expand Up @@ -38,12 +41,16 @@ settings, Actions policies, and runner group in `organization.tf`.
in `mandatory_target_repositories_present` in `checks.tf` (updating its
count and message).
2. Add one import triple (settings + `protect_main` + `protect_tags`) to
`imports.tf` using the live numeric ruleset IDs.
`imports.tf` using the live numeric ruleset IDs. A private repository gets
only the settings import; an archived one gets only the two ruleset imports.

## Per-repository options

Each `repository_policies` entry may also set:

- `archived` (default `false`): set it for a repository that is archived on
GitHub. The module then skips its settings and reads its ID through a data
source; its rulesets stay managed.
- `strict_required_status_checks` (default `false`): require the branch to be
up to date with the default branch before merging.
- `protect_tags_update` (default `false`): add the `update` rule to
Expand Down
2 changes: 1 addition & 1 deletion checks.tf
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ check "no_ci_exception_allowlist_is_explicit" {
check "self_protection_enforced" {
assert {
condition = contains(keys(var.repository_policies), "github-terraform")
error_message = "tailrocks/github-terraform must remain in the managed repository inventory; every inventory entry receives both rulesets."
error_message = "tailrocks/github-terraform must remain in the managed repository inventory; every public inventory entry receives both rulesets."
}
}

Expand Down
33 changes: 12 additions & 21 deletions imports.tf
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {
id = "3"
}

# Managed repository settings imports
# Managed repository settings imports (archived repositories are not managed, so they have none)
import {
to = module.repository_policy.github_repository.managed_settings["cloudflare-tofu"]
id = "cloudflare-tofu"
Expand Down Expand Up @@ -70,11 +70,6 @@ import {
id = "homebrew-tablerock"
}

import {
to = module.repository_policy.github_repository.managed_settings["homebrew-velnor-legacy"]
id = "homebrew-velnor-legacy"
}

import {
to = module.repository_policy.github_repository.managed_settings["jambalaya"]
id = "jambalaya"
Expand Down Expand Up @@ -221,21 +216,6 @@ import {
to = module.repository_policy.github_repository.managed_settings["tuiscotti"]
id = "tuiscotti"
}
import {
to = module.repository_policy.github_repository.managed_settings["velnor-legacy"]
id = "velnor-legacy"
}

import {
to = module.repository_policy.github_repository.managed_settings["velnor-actions-fixture-legacy"]
id = "velnor-actions-fixture-legacy"
}

import {
to = module.repository_policy.github_repository.managed_settings["velnor-apt-legacy"]
id = "velnor-apt-legacy"
}

import {
to = module.repository_policy.github_repository.managed_settings["velnor-new"]
id = "velnor-new"
Expand Down Expand Up @@ -700,3 +680,14 @@ import {
to = module.repository_policy.github_repository_ruleset.tag_creation["velnor-new/sdk-preview-owner-creation"]
id = "velnor-new:26696396"
}

# Existing terminal-components-claude rulesets
import {
to = module.repository_policy.github_repository_ruleset.protect_main["terminal-components-claude"]
id = "terminal-components-claude:24883153"
}

import {
to = module.repository_policy.github_repository_ruleset.protect_tags["terminal-components-claude"]
id = "terminal-components-claude:24883130"
}
37 changes: 31 additions & 6 deletions modules/repository-policy/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,25 @@ terraform {
}

locals {
managed_repositories = toset(keys(var.repository_policies))
# Every inventory key; archived repositories are read-only on GitHub, so only the
# active ones get managed settings.
inventory_repositories = toset(keys(var.repository_policies))
managed_repositories = toset([
for name, policy in var.repository_policies : name if !policy.archived
])
archived_repositories = setsubtract(local.inventory_repositories, local.managed_repositories)

# A private repository on the free plan cannot have rulesets: the rulesets API
# answers 403 "Upgrade to GitHub Pro".
ruleset_repositories = toset([
for name, policy in var.repository_policies : name if policy.visibility == "public"
])

# Repository names for rulesets, taken from the settings resource when it exists.
repository_names = merge(
{ for name, repo in github_repository.managed_settings : name => repo.name },
{ for name, repo in data.github_repository.archived : name => repo.name },
)

# Keyed "<repository>/<ruleset name>".
tag_creation_rulesets = merge([
Expand All @@ -28,6 +46,13 @@ locals {
]...)
}

# Archived repositories: read only, so that their IDs stay available without any write.
data "github_repository" "archived" {
for_each = local.archived_repositories

name = each.value
}

# Repository-level merge settings (Tier 1 enforcement across all repos)
resource "github_repository" "managed_settings" {
for_each = local.managed_repositories
Expand Down Expand Up @@ -74,12 +99,12 @@ resource "github_repository" "managed_settings" {

# Branch ruleset on main / default branch (Tier 2 ref protection)
resource "github_repository_ruleset" "protect_main" {
for_each = local.managed_repositories
for_each = local.ruleset_repositories

name = "protect-main"
target = "branch"
enforcement = "active"
repository = github_repository.managed_settings[each.value].name
repository = local.repository_names[each.value]

conditions {
ref_name {
Expand Down Expand Up @@ -124,12 +149,12 @@ resource "github_repository_ruleset" "protect_main" {

# Tag ruleset protecting all tags
resource "github_repository_ruleset" "protect_tags" {
for_each = local.managed_repositories
for_each = local.ruleset_repositories

name = "protect-tags"
target = "tag"
enforcement = "active"
repository = github_repository.managed_settings[each.value].name
repository = local.repository_names[each.value]

conditions {
ref_name {
Expand All @@ -152,7 +177,7 @@ resource "github_repository_ruleset" "tag_creation" {
name = each.value.name
target = "tag"
enforcement = "active"
repository = github_repository.managed_settings[each.value.repository].name
repository = local.repository_names[each.value.repository]

conditions {
ref_name {
Expand Down
6 changes: 3 additions & 3 deletions modules/repository-policy/outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# SPDX-License-Identifier: Apache-2.0

output "managed_repositories" {
description = "Set of managed repository names (inventory keys)"
value = local.managed_repositories
description = "Set of inventory repository names, including archived ones"
value = local.inventory_repositories
}

output "repository_settings" {
Expand Down Expand Up @@ -32,7 +32,7 @@ output "required_check_contexts" {
output "repository_ids" {
description = "Map of repository name to repository ID"
value = {
for k, v in github_repository.managed_settings : k => v.repo_id
for k, v in merge(github_repository.managed_settings, data.github_repository.archived) : k => v.repo_id
}
}

Expand Down
3 changes: 3 additions & 0 deletions modules/repository-policy/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ variable "repository_policies" {
visibility = string # "public" | "private"
required_checks = list(string)
no_ci_reason = optional(string)
# Archived repositories are read-only on GitHub: their settings are not managed
# and only their rulesets are tracked.
archived = optional(bool, false)
# Require branches to be up to date with the default branch before merging.
strict_required_status_checks = optional(bool, false)
# Also block moving existing tags (the update rule) in protect-tags.
Expand Down
22 changes: 1 addition & 21 deletions moved.tf
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# SPDX-FileCopyrightText: 2026 Alexey Zhokhov
# SPDX-License-Identifier: Apache-2.0

# Four repositories carry a -legacy suffix on GitHub. These blocks move their state
# Four repositories carry a -legacy suffix on GitHub. These blocks move their ruleset state
# entries to the matching inventory keys so that no resource is destroyed.
# Delete this file after the first apply that includes it.

moved {
from = module.repository_policy.github_repository.managed_settings["homebrew-velnor"]
to = module.repository_policy.github_repository.managed_settings["homebrew-velnor-legacy"]
}

moved {
from = module.repository_policy.github_repository_ruleset.protect_main["homebrew-velnor"]
to = module.repository_policy.github_repository_ruleset.protect_main["homebrew-velnor-legacy"]
Expand All @@ -20,11 +15,6 @@ moved {
to = module.repository_policy.github_repository_ruleset.protect_tags["homebrew-velnor-legacy"]
}

moved {
from = module.repository_policy.github_repository.managed_settings["velnor"]
to = module.repository_policy.github_repository.managed_settings["velnor-legacy"]
}

moved {
from = module.repository_policy.github_repository_ruleset.protect_main["velnor"]
to = module.repository_policy.github_repository_ruleset.protect_main["velnor-legacy"]
Expand All @@ -35,11 +25,6 @@ moved {
to = module.repository_policy.github_repository_ruleset.protect_tags["velnor-legacy"]
}

moved {
from = module.repository_policy.github_repository.managed_settings["velnor-actions-fixture"]
to = module.repository_policy.github_repository.managed_settings["velnor-actions-fixture-legacy"]
}

moved {
from = module.repository_policy.github_repository_ruleset.protect_main["velnor-actions-fixture"]
to = module.repository_policy.github_repository_ruleset.protect_main["velnor-actions-fixture-legacy"]
Expand All @@ -50,11 +35,6 @@ moved {
to = module.repository_policy.github_repository_ruleset.protect_tags["velnor-actions-fixture-legacy"]
}

moved {
from = module.repository_policy.github_repository.managed_settings["velnor-apt"]
to = module.repository_policy.github_repository.managed_settings["velnor-apt-legacy"]
}

moved {
from = module.repository_policy.github_repository_ruleset.protect_main["velnor-apt"]
to = module.repository_policy.github_repository_ruleset.protect_main["velnor-apt-legacy"]
Expand Down
9 changes: 9 additions & 0 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ variable "repository_policies" {
visibility = string
required_checks = list(string)
no_ci_reason = optional(string)
# Archived repositories are read-only on GitHub: their settings are not managed
# and only their rulesets are tracked.
archived = optional(bool, false)
# Require branches to be up to date with the default branch before merging.
strict_required_status_checks = optional(bool, false)
# Also block moving existing tags (the update rule) in protect-tags.
Expand Down Expand Up @@ -99,6 +102,7 @@ variable "repository_policies" {
required_checks = ["DCO", "Required"]
}
"homebrew-velnor-legacy" = {
archived = true
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Required"]
Expand Down Expand Up @@ -158,6 +162,8 @@ variable "repository_policies" {
required_checks = ["DCO", "Required"]
}
"tailrocks-asd-ste100-skills" = {
# Private on the free plan: GitHub refuses rulesets here (403 "Upgrade to GitHub Pro"),
# so the module declares none for it. Check list kept for the day it goes public.
# local.check_templates.required_only
visibility = "private"
required_checks = ["Required"]
Expand Down Expand Up @@ -243,10 +249,12 @@ variable "repository_policies" {
required_checks = ["DCO", "Required"]
}
"velnor-actions-fixture-legacy" = {
archived = true
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
}
"velnor-apt-legacy" = {
archived = true
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Required"]
Expand All @@ -257,6 +265,7 @@ variable "repository_policies" {
required_checks = ["DCO"]
}
"velnor-legacy" = {
archived = true
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Required"]
Expand Down
Loading