Skip to content

chore(github/repository): limit the platform production environment to release tags - #1107

Merged
panicboat merged 2 commits into
mainfrom
chore/production-environment-deployment-policy
Oct 24, 2026
Merged

panicboat merged 2 commits into
mainfrom
chore/production-environment-deployment-policy

Conversation

@panicboat

Copy link
Copy Markdown
Owner

Why

production の apply role は OIDC subject repo:panicboat/platform:environment:production を許可している。
job が environment: production を宣言すれば、どの branch から起動した workflow でもこの token を得られる。
GitHub environment production に deployment policy を付け、release tag(<service>-vX.Y.Z)以外の ref で動く job を GitHub に止めさせる。

What

  • github/repository の module で、repository ごとに GitHub environment と tag pattern の deployment policy を宣言できるようにする。
  • platform の production に tag pattern *-v* を設定する。
    • custom_branch_policies = true にして、policy に一致しない ref からの deployment を拒否させる。
    • can_admins_bypass = false にして、admin が起動した job も同じ扱いにする。
  • mock provider の tftest で、environment と policy の key・属性を確かめる。
  • README に、production が tag *-v* からの deployment だけを受け付けることを書く。

Merge 順と影響

Test plan

  • tofu test(github/repository/modules)が 2 passed
  • policy の参照・can_admins_bypass・custom_branch_policies などを壊すと、テストが失敗する
  • tofu fmt -check -recursive github/repository と tofu validate が成功
  • PR 上の github/repository の plan に、environment と policy の追加だけが出る
  • merge 後、gh api repos/panicboat/platform/environments/production で policy が tag *-v* になっている
  • tag 以外の branch から environment: production の job を起動すると、GitHub に拒否される
  • release tag からの apply(ci: gate production terragrunt applies behind service releases #1105 の E2E)が、この policy の下で動く

🤖 Generated with Claude Code

https://claude.ai/code/session_01BZfNTtmPjmrDmh1MAMtiFS

…o release tags

Signed-off-by: panicboat <panicboat@gmail.com>
…onment

Signed-off-by: panicboat <panicboat@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ac99c847-a314-4106-b19e-4f738000190b
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@panicboat-github-workflow-bot panicboat-github-workflow-bot Bot added the deploy:repository Auto-generated deployment label label Oct 24, 2026
@panicboat-github-workflow-bot

Copy link
Copy Markdown
Contributor

Plan Result (repository/master)

CI link

Plan: 2 to add, 0 to change, 0 to destroy.
  • Create
    • github_repository_environment.repository["platform/production"]
    • github_repository_environment_deployment_policy.repository["platform/production/-v"]
Change Result (Click me)
  # github_repository_environment.repository["platform/production"] will be created
  + resource "github_repository_environment" "repository" {
      + can_admins_bypass   = false
      + environment         = "production"
      + id                  = (known after apply)
      + prevent_self_review = false
      + repository          = "platform"
      + repository_id       = (known after apply)

      + deployment_branch_policy {
          + custom_branch_policies = true
          + protected_branches     = false
        }
    }

  # github_repository_environment_deployment_policy.repository["platform/production/*-v*"] will be created
  + resource "github_repository_environment_deployment_policy" "repository" {
      + environment   = "production"
      + id            = (known after apply)
      + policy_id     = (known after apply)
      + repository    = "platform"
      + repository_id = (known after apply)
      + tag_pattern   = "*-v*"
    }

Plan: 2 to add, 0 to change, 0 to destroy.

@panicboat
panicboat marked this pull request as ready for review October 24, 2026 12:56
@panicboat
panicboat merged commit ae5b4ae into main Oct 24, 2026
15 checks passed
@panicboat
panicboat deleted the chore/production-environment-deployment-policy branch October 24, 2026 12:56
@panicboat-github-workflow-bot

Copy link
Copy Markdown
Contributor

✅ Apply Succeeded (repository/master)

CI link

Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
Details (Click me)
Oct 24 12:57:28.904 INF download and unarchive the package program=aqua version=2.64.0 env=linux/amd64 exe_name=terragrunt package_name=gruntwork-io/terragrunt package_version=v1.0.2 registry=standard

Initializing the backend...

Successfully configured the backend "s3"! OpenTofu will automatically
use this backend unless the backend configuration changes.

Initializing provider plugins...
- Finding hashicorp/aws versions matching "~> 6.68"...
- Finding integrations/github versions matching "~> 6.13"...
- Installing integrations/github v6.13.0 to the shared cache directory...
- Installing hashicorp/aws v6.70.0 to the shared cache directory...
- Installed integrations/github v6.13.0 (signed, key ID 38027F80D7FD5FB2)
- Using integrations/github v6.13.0 from the shared cache directory
- Installed hashicorp/aws v6.70.0 (signed, key ID 0C0AF313E5FD9F80)
- Using hashicorp/aws v6.70.0 from the shared cache directory

Providers are signed by their developers.
If you'd like to know more about provider signing, you can read about it here:
https://opentofu.org/docs/cli/plugins/signing/

OpenTofu has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that OpenTofu can guarantee to make the same selections by default when
you run "tofu init" in the future.

OpenTofu has been successfully initialized!

You may now begin working with OpenTofu. Try running "tofu plan" to see
any changes that are required for your infrastructure. All OpenTofu commands
should now work.

If you ever set or change modules or backend configuration for OpenTofu,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.
github_repository.repository["monorepo"]: Refreshing state... [id=monorepo]
github_repository.repository["deploy-actions"]: Refreshing state... [id=deploy-actions]
github_repository.repository["platform"]: Refreshing state... [id=platform]
github_repository.repository["dotfiles"]: Refreshing state... [id=dotfiles]
github_repository.repository["ansible"]: Refreshing state... [id=ansible]
github_workflow_repository_permissions.repository["platform"]: Refreshing state... [id=platform]
github_workflow_repository_permissions.repository["monorepo"]: Refreshing state... [id=monorepo]
github_repository_vulnerability_alerts.repository["platform"]: Refreshing state... [id=994278495]
github_repository_vulnerability_alerts.repository["deploy-actions"]: Refreshing state... [id=1014666976]
github_repository_vulnerability_alerts.repository["monorepo"]: Refreshing state... [id=807388271]
github_repository_vulnerability_alerts.repository["ansible"]: Refreshing state... [id=880089351]
github_repository_vulnerability_alerts.repository["dotfiles"]: Refreshing state... [id=880093624]

OpenTofu used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create

OpenTofu will perform the following actions:

  # github_repository_environment.repository["platform/production"] will be created
  + resource "github_repository_environment" "repository" {
      + can_admins_bypass   = false
      + environment         = "production"
      + id                  = (known after apply)
      + prevent_self_review = false
      + repository          = "platform"
      + repository_id       = (known after apply)

      + deployment_branch_policy {
          + custom_branch_policies = true
          + protected_branches     = false
        }
    }

  # github_repository_environment_deployment_policy.repository["platform/production/*-v*"] will be created
  + resource "github_repository_environment_deployment_policy" "repository" {
      + environment   = "production"
      + id            = (known after apply)
      + policy_id     = (known after apply)
      + repository    = "platform"
      + repository_id = (known after apply)
      + tag_pattern   = "*-v*"
    }

Plan: 2 to add, 0 to change, 0 to destroy.
github_repository_environment.repository["platform/production"]: Creating...
github_repository_environment.repository["platform/production"]: Creation complete after 2s [id=platform:production]
github_repository_environment_deployment_policy.repository["platform/production/*-v*"]: Creating...
github_repository_environment_deployment_policy.repository["platform/production/*-v*"]: Creation complete after 1s [id=platform:production:64198899]

Apply complete! Resources: 2 added, 0 changed, 0 destroyed.

Outputs:

repository_full_names = {
  "ansible" = "panicboat/ansible"
  "deploy-actions" = "panicboat/deploy-actions"
  "dotfiles" = "panicboat/dotfiles"
  "monorepo" = "panicboat/monorepo"
  "platform" = "panicboat/platform"
}
repository_html_urls = {
  "ansible" = "https://github.com/panicboat/ansible"
  "deploy-actions" = "https://github.com/panicboat/deploy-actions"
  "dotfiles" = "https://github.com/panicboat/dotfiles"
  "monorepo" = "https://github.com/panicboat/monorepo"
  "platform" = "https://github.com/panicboat/platform"
}
repository_http_clone_urls = {
  "ansible" = "https://github.com/panicboat/ansible.git"
  "deploy-actions" = "https://github.com/panicboat/deploy-actions.git"
  "dotfiles" = "https://github.com/panicboat/dotfiles.git"
  "monorepo" = "https://github.com/panicboat/monorepo.git"
  "platform" = "https://github.com/panicboat/platform.git"
}
repository_ids = {
  "ansible" = 880089351
  "deploy-actions" = 1014666976
  "dotfiles" = 880093624
  "monorepo" = 807388271
  "platform" = 994278495
}
repository_node_ids = {
  "ansible" = "R_kgDONHUZBw"
  "deploy-actions" = "R_kgDOPHqW4A"
  "dotfiles" = "R_kgDONHUpuA"
  "monorepo" = "R_kgDOMB_Ebw"
  "platform" = "R_kgDOO0N8Xw"
}
repository_ssh_clone_urls = {
  "ansible" = "git@github.com:panicboat/ansible.git"
  "deploy-actions" = "git@github.com:panicboat/deploy-actions.git"
  "dotfiles" = "git@github.com:panicboat/dotfiles.git"
  "monorepo" = "git@github.com:panicboat/monorepo.git"
  "platform" = "git@github.com:panicboat/platform.git"
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy:repository Auto-generated deployment label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant