Add config settings by solababs · Pull Request #8600 · opsmill/infrahub

solababs · 2026-03-13T21:49:23Z

Why

There is no configuration surface for controlling automatic branch deletion after merge. Without these settings, the feature cannot be safely rolled out — behavior needs to default to off and be explicitly opt-in.

This PR adds the two config flags that gate the feature, along with a dependency validator between them. It is Phase 1 of the full implementation plan.

What changed

Added delete_branch_after_merge: bool (default false) to MainSettings — when enabled, the Infrahub branch is automatically deleted after a successful merge.
Added delete_git_branch_after_merge: bool (default false) to MainSettings — when enabled, the corresponding Git branch is also deleted; requires delete_branch_after_merge to be enabled.
Added a @model_validator that raises at startup if delete_git_branch_after_merge=true without delete_branch_after_merge=true, preventing a misconfigured state.
Added 3 unit tests covering the defaults and the validation error.

No behavioral changes beyond the new config fields — no deletion logic is wired up yet.

Suggested review order

backend/infrahub/config.py — the two new fields and the validator
backend/tests/unit/test_config.py — unit tests

How to review

Focus on the validator logic in config.py — specifically whether the error message and validation mode (after) are appropriate. The rest is straightforward field additions.

No schema, API, or database changes in this PR.

How to test

# Run the new tests
uv run pytest backend/tests/unit/test_config.py -v -k "delete_branch"

# Full unit suite
uv run invoke backend.test-unit

Expected: all three new tests pass. Attempting to instantiate MainSettings(delete_git_branch_after_merge=True, delete_branch_after_merge=False) raises a ValidationError with the message requires 'delete_branch_after_merge' to be enabled.

Impact & rollout

Backward compatibility: No breaking changes. Both settings default to false, so existing deployments are unaffected.
Config/env changes: Two new optional settings in MainSettings: delete_branch_after_merge and delete_git_branch_after_merge.
Deployment notes: Safe to deploy independently. The deletion logic is not implemented yet.

Checklist

Tests added/updated
Changelog entry added (uv run towncrier create ...)
External docs updated (if user-facing or ops-facing change)
Internal .md docs updated (internal knowledge and AI code tools knowledge)

coderabbitai · 2026-03-13T21:49:34Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (4)

main
stable
develop
release-.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dda6c205-75e0-4bf8-aef1-e5c4b03cae42

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Coding Plan

Generate coding plan for human review comments

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 and usage tips.}

codspeed-hq · 2026-03-13T21:55:43Z

Merging this PR will not alter performance

✅ 12 untouched benchmarks

_{Comparing sb-13032026-add-config-settings-ifc-2336 (c8d572c) with stable (a5fd2a7)¹}

No successful run was found on sb-13032026-delete-branch-after-merge-ifc-2336 (b486124) during the generation of this report, so stable (a5fd2a7) was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

…-13032026-add-config-settings-ifc-2336

ajtmccarty · 2026-03-17T16:14:47Z

backend/infrahub/config.py

+    delete_git_branch_after_merge: bool = Field(
+        default=False,
+        description="When enabled, the corresponding Git branch is deleted after the Infrahub branch is deleted. "
+        "Requires delete_branch_after_merge to be enabled.",
+    )


probably more of a design-level question, but it seems like we should be able to delete a branch on git regardless of whether the branch is being automatically deleted after a merge or manually deleted later

@ajtmccarty as seen here #8431 (comment), i think this was intentionally designed this way

For context the reasoning around this is around the fact that it could be misleading that the branch within Infrahub is setup to be synced with Git but then we don't have a matching branch in Git for those branches. We might of course run into the same issue if the branch is deleted on the Git server itself.

ogenstad · 2026-03-18T08:59:02Z

backend/infrahub/config.py

+        default=False,
+        description="When enabled, the Infrahub branch is automatically deleted after a successful merge.",
+    )
+    delete_git_branch_after_merge: bool = Field(


Hm, we have the GitSettings section for git specific things. I think it would make more sense to have this setting under that section instead. Even if it would cause changes to the validator. Perhaps the validator could live in the Settings class?

…-13032026-add-config-settings-ifc-2336

ogenstad · 2026-03-19T13:44:39Z

backend/tests/unit/test_config.py

+
+
+def test_delete_git_branch_after_merge_defaults_to_false() -> None:
+    assert GitSettings().delete_git_branch_after_merge is False


I think we can get rid of test_delete_branch_after_merge_defaults_to_false and test_delete_git_branch_after_merge_defaults_to_false as they just validate the default setting in the class and we don't have that for any of the other config options.

ogenstad · 2026-03-19T13:45:32Z

backend/infrahub/config.py

+    def validate_git_branch_deletion_requires_branch_deletion(self) -> Self:
+        if self.git.delete_git_branch_after_merge and not self.main.delete_branch_after_merge:
+            raise ValueError(
+                "'git.delete_git_branch_after_merge' requires 'main.delete_branch_after_merge' to be enabled"


From a users point of view they might not know that the config is divided into sections like this so I think we can remove the "git." and "main." prefix in the error here.

Add config settings

7c1e533

github-actions bot added the group/backend Issue related to the backend (API Server, Git Agent) label Mar 13, 2026

update implementation plan and phase

1d8f22f

solababs marked this pull request as ready for review March 17, 2026 11:26

solababs requested a review from a team as a code owner March 17, 2026 11:26

update docs and schema

bbb5ced

solababs requested review from a team as code owners March 17, 2026 11:50

github-actions bot added the type/documentation Improvements or additions to documentation label Mar 17, 2026

solababs added 2 commits March 17, 2026 12:51

Merge branch 'sb-13032026-delete-branch-after-merge-ifc-2336' into sb…

8757f6b

…-13032026-add-config-settings-ifc-2336

update frontend types

b07039d

github-actions bot added the group/frontend Issue related to the frontend (React) label Mar 17, 2026

ajtmccarty approved these changes Mar 17, 2026

View reviewed changes

ogenstad reviewed Mar 18, 2026

View reviewed changes

solababs added 2 commits March 19, 2026 13:30

Merge branch 'sb-13032026-delete-branch-after-merge-ifc-2336' into sb…

872caa0

…-13032026-add-config-settings-ifc-2336

move git settings to appropiate GitSettings

a421239

solababs requested a review from ogenstad March 19, 2026 13:00

fix lint error

c8d572c

ogenstad approved these changes Mar 19, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add config settings#8600

Add config settings#8600
solababs wants to merge 8 commits intosb-13032026-delete-branch-after-merge-ifc-2336from
sb-13032026-add-config-settings-ifc-2336

solababs commented Mar 13, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 13, 2026 •

edited

Loading

Review skipped

Uh oh!

codspeed-hq bot commented Mar 13, 2026 •

edited

Loading

Uh oh!

ajtmccarty Mar 17, 2026

Uh oh!

solababs Mar 17, 2026

Uh oh!

ogenstad Mar 18, 2026

Uh oh!

ogenstad Mar 18, 2026

Uh oh!

ogenstad Mar 19, 2026

Uh oh!

ogenstad Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants



		def test_delete_git_branch_after_merge_defaults_to_false() -> None:
		assert GitSettings().delete_git_branch_after_merge is False

Conversation

solababs commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

What changed

Suggested review order

How to review

How to test

Impact & rollout

Checklist

Uh oh!

coderabbitai bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

codspeed-hq bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

ajtmccarty Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

solababs Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

ogenstad Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

ogenstad Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

ogenstad Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

ogenstad Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

solababs commented Mar 13, 2026 •

edited

Loading

coderabbitai bot commented Mar 13, 2026 •

edited

Loading

codspeed-hq bot commented Mar 13, 2026 •

edited

Loading