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
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

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.
settings plus `protect-main` and `protect-tags` rulesets, and optional
per-repository tag-creation rulesets.

## Layout

Expand All @@ -28,6 +29,7 @@ settings, Actions policies, and runner group in `organization.tf`.

1. Add one entry to `repository_policies` in `variables.tf`, copying a check
list from `locals.tf` (`dco_policy_ci` = `["DCO", "Policy", "ci-required"]`,
`dco_required` = `["DCO", "Required"]`,
`control` = `["Control / Required"]`, `required_only` = `["Required"]`,
`dco_only` = `["DCO"]`, `policy` = `["Policy"]`); bespoke checks inline
with a comment citing the producing workflow. Repos with no CI use
Expand All @@ -38,6 +40,19 @@ settings, Actions policies, and runner group in `organization.tf`.
2. Add one import triple (settings + `protect_main` + `protect_tags`) to
`imports.tf` using the live numeric ruleset IDs.

## Per-repository options

Each `repository_policies` entry may also set:

- `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
`protect-tags`, so that existing tags cannot move.
- `tag_creation_rulesets` (default `{}`): extra tag rulesets, keyed by ruleset
name, with the `creation` rule for the `include` patterns and an `always`
bypass for each user in `bypass_user_ids`. Import each existing ruleset as
`tag_creation["<repository>/<ruleset name>"]` in `imports.tf`.

## Organization overlays

- `organization.tf` manages the org profile (`github_organization_settings`),
Expand Down
12 changes: 12 additions & 0 deletions checks.tf
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,15 @@ check "zero_bypass_actors" {
error_message = "No repository may declare bypass actors on its protect-main ruleset."
}
}

check "velnor_new_release_tags_reserved" {
assert {
condition = (
toset(var.repository_policies["velnor-new"].tag_creation_rulesets["release-tags"].include) == toset([
"refs/tags/rust-ci-v*", "refs/tags/velnor-ci-v*", "refs/tags/velnor-gen-v*",
]) &&
length(var.repository_policies["velnor-new"].tag_creation_rulesets["release-tags"].bypass_user_ids) == 1
)
error_message = "tailrocks/velnor-new must keep the release-tags ruleset: rust-ci-v*, velnor-ci-v*, and velnor-gen-v* tags, created only by one bypass user (tailrocks/velnor-new#682)."
}
}
11 changes: 11 additions & 0 deletions imports.tf
Original file line number Diff line number Diff line change
Expand Up @@ -689,3 +689,14 @@ import {
to = module.repository_policy.github_repository_ruleset.protect_tags["velnor-lab"]
id = "velnor-lab:27119696"
}

# Existing tag-creation ruleset imports
import {
to = module.repository_policy.github_repository_ruleset.tag_creation["velnor-new/release-tags"]
id = "velnor-new:27276267"
}

import {
to = module.repository_policy.github_repository_ruleset.tag_creation["velnor-new/sdk-preview-owner-creation"]
id = "velnor-new:26696396"
}
1 change: 1 addition & 0 deletions locals.tf
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ locals {
# with a comment citing the producing workflow.
check_templates = {
dco_policy_ci = ["DCO", "Policy", "ci-required"]
dco_required = ["DCO", "Required"]
control = ["Control / Required"]
required_only = ["Required"]
dco_only = ["DCO"]
Expand Down
45 changes: 44 additions & 1 deletion modules/repository-policy/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ terraform {

locals {
managed_repositories = toset(keys(var.repository_policies))

# Keyed "<repository>/<ruleset name>".
tag_creation_rulesets = merge([
for repository, policy in var.repository_policies : {
for name, ruleset in policy.tag_creation_rulesets : "${repository}/${name}" => {
repository = repository
name = name
include = ruleset.include
bypass_user_ids = ruleset.bypass_user_ids
}
}
]...)
}

# Repository-level merge settings (Tier 1 enforcement across all repos)
Expand Down Expand Up @@ -96,7 +108,7 @@ resource "github_repository_ruleset" "protect_main" {
dynamic "required_status_checks" {
for_each = length(var.repository_policies[each.value].required_checks) > 0 ? [1] : []
content {
strict_required_status_checks_policy = false
strict_required_status_checks_policy = var.repository_policies[each.value].strict_required_status_checks
do_not_enforce_on_create = false

dynamic "required_check" {
Expand Down Expand Up @@ -129,5 +141,36 @@ resource "github_repository_ruleset" "protect_tags" {
rules {
deletion = true
non_fast_forward = true
update = var.repository_policies[each.value].protect_tags_update
}
}

# Tag rulesets that let only the listed users create matching tags
resource "github_repository_ruleset" "tag_creation" {
for_each = local.tag_creation_rulesets

name = each.value.name
target = "tag"
enforcement = "active"
repository = github_repository.managed_settings[each.value.repository].name

conditions {
ref_name {
include = each.value.include
exclude = []
}
}

dynamic "bypass_actors" {
for_each = each.value.bypass_user_ids
content {
actor_id = bypass_actors.value
actor_type = "User"
bypass_mode = "always"
}
}

rules {
creation = true
}
}
10 changes: 10 additions & 0 deletions modules/repository-policy/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ variable "repository_policies" {
visibility = string # "public" | "private"
required_checks = list(string)
no_ci_reason = optional(string)
# 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.
protect_tags_update = optional(bool, false)
# Extra tag rulesets, keyed by ruleset name, that restrict tag creation for the
# include patterns to the listed user IDs.
tag_creation_rulesets = optional(map(object({
include = list(string)
bypass_user_ids = list(number)
})), {})
}))

validation {
Expand Down
84 changes: 63 additions & 21 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ variable "repository_policies" {
visibility = string
required_checks = list(string)
no_ci_reason = optional(string)
# 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.
protect_tags_update = optional(bool, false)
# Extra tag rulesets, keyed by ruleset name, that restrict tag creation for the
# include patterns to the listed user IDs.
tag_creation_rulesets = optional(map(object({
include = list(string)
bypass_user_ids = list(number)
})), {})
}))

validation {
Expand Down Expand Up @@ -59,49 +69,59 @@ variable "repository_policies" {
required_checks = ["Policy"]
}
"holla" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"holla-apt" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"homebrew-holla" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"homebrew-parallax" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"homebrew-ruxel" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"homebrew-tablerock" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"homebrew-velnor-legacy" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"jambalaya" = {
visibility = "public"
required_checks = []
no_ci_reason = "Live protect-main ruleset carries no required status-check rule; no CI workflow emits a status context."
}
"parallax" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"parallax-telemetry-playground" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"pg-bigdecimal" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"pgquill" = {
visibility = "public"
Expand All @@ -123,16 +143,19 @@ variable "repository_policies" {
no_ci_reason = "No CI workflow emits a status context on the default branch; only tag-push release checks exist."
}
"ruxel" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"schemalane" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"tablerock" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"tailrocks-asd-ste100-skills" = {
# local.check_templates.required_only
Expand Down Expand Up @@ -200,16 +223,19 @@ variable "repository_policies" {
required_checks = ["Required"]
}
"termpane" = {
visibility = "public"
required_checks = ["DCO", "Required"]
visibility = "public"
required_checks = ["DCO", "Required"]
protect_tags_update = true
}
"termrock" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"tracing-request-level" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"tuiscotti" = {
# Bespoke: matches live protect-main ruleset 23746094 required contexts (DCO + Required).
Expand All @@ -221,21 +247,37 @@ variable "repository_policies" {
required_checks = ["DCO", "Policy", "ci-required"]
}
"velnor-apt-legacy" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"velnor-lab" = {
# dco_only until the generated Rust CI workflow exists; then add its gate check.
visibility = "public"
required_checks = ["DCO"]
}
"velnor-legacy" = {
# local.check_templates.dco_required
visibility = "public"
required_checks = ["DCO", "Policy", "ci-required"]
required_checks = ["DCO", "Required"]
}
"velnor-new" = {
visibility = "public"
required_checks = ["Required"]
visibility = "public"
required_checks = ["Required"]
strict_required_status_checks = true
protect_tags_update = true
tag_creation_rulesets = {
# Only the owner may create release tags (tailrocks/velnor-new#682).
# The velnor-release GitHub App replaces this bypass later.
"release-tags" = {
include = ["refs/tags/rust-ci-v*", "refs/tags/velnor-ci-v*", "refs/tags/velnor-gen-v*"]
bypass_user_ids = [139017] # donbeave
}
"sdk-preview-owner-creation" = {
include = ["refs/tags/sdk-preview-*"]
bypass_user_ids = [139017] # donbeave
}
}
}
"vision" = {
visibility = "public"
Expand Down