Using Merge Proposals

This guide will show you how to use merge proposals in Flipt v2.

This functionality is only available in Flipt v2 Pro. Learn more about our commercial license or purchase a monthly or annual license.

Prerequisites

Flipt v2
An understanding of Flipt v2 Branching
A Flipt v2 environment configured with Git Sync and Git SCM
A Flipt v2 Pro license or trial license

Flipt v2 merge proposals are supported by most of the major Git providers including GitHub, GitLab, Bitbucket, Gitea, and Azure DevOps.

Using Merge Proposals

Flipt v2 allows you to create merge proposals for your environments. This is useful if you want to review and approve changes to your environments before they are merged into the source environment.

Creating a Merge Proposal

To create a merge proposal you must first create a branch. See the Branching guide for more information on how to create a branch. Once you have created a branch and made changes to your environment, you can create a merge proposal by clicking the branch info label in the top right of the Flipt UI. This will bring up a menu allowing you to view the remote branch, propose changes, or delete the branch. Click the Propose changes button to create a merge proposal. This will bring up a modal allowing you to review the changes you are proposing, add an optional description and optionally open the merge proposal in ‘draft’ mode for those SCM providers that support it.

If you don’t provide a description one will be generated for you based on the changes you are proposing.

Click the Submit proposal button to create a merge proposal. You should see a success message and the merge proposal will be created. Refresh the page and click the branch info label again to see the merge proposal in the menu. Click the View open merge proposal button to view the merge proposal in the SCM provider.

Customizing Generated Titles and Descriptions

Flipt generates merge proposal titles and descriptions from Go text/template templates. You can configure server-wide defaults in your Flipt configuration:

config.yaml

templates:
  proposal_title: "Flipt: Update {{.Base.Ref}} from {{.Branch.Ref}}"
  proposal_body: |
    This proposal updates Flipt resources.

    Source branch: {{.Branch.Ref}}
    Target branch: {{.Base.Ref}}

The template context includes:

Field	Description
`.Base`	The target environment configuration
`.Branch`	The source branch environment configuration
`.Base.Ref`	The target Git reference, such as `main`
`.Branch.Ref`	The source Git reference for the branch
`.Base.Directory`	The target directory, when one is configured
`.Branch.Directory`	The branch directory, when one is configured

Repository-level templates in flipt.yaml or flipt.yml override the server-wide templates for that repository:

flipt.yaml

version: "2.0"
templates:
  proposal_title: "Flags: {{.Branch.Ref}} into {{.Base.Ref}}"
  proposal_body: |
    Review changes from {{.Branch.Ref}} before merging into {{.Base.Ref}}.

These templates configure the generated defaults. If a merge proposal request provides a title or description, Flipt uses the provided value instead of the template. The Flipt UI can provide a one-off description, but it does not yet let you edit the configured template text or override the generated title directly.

Review and Merge a Merge Proposal

Reviewing and merging a merge proposal is the same as reviewing and merging a code pull request in your SCM provider. Once the merge proposal is approved, you can merge it into the source environment by clicking the Merge button or similar button in your SCM provider. After the merge proposal is merged on the SCM provider, the changes will be synced to the source environment. Refresh the Flipt v2 UI and you should see the changes in the source environment.

You will need to wait until the merge proposal is synced by the Flipt v2 server you can see the changes. This is entirely dependent on the poll_interval configured in your Flipt configuration file for your Git environment storage.

Close a Merge Proposal

Closing a merge proposal before merging follows the same process as closing a code pull request in your SCM provider. To close a merge proposal, click the Close button or similar button in your SCM provider. After the merge proposal is closed on the SCM provider, the changes will be reflected in the Flipt v2 UI.

If you also delete the branch on the SCM provider the branch will not be deleted from the Flipt v2 server. This is because the branch still exists in your configured git environment storage.

Getting Started

Pro Features

Configuration

Integration

CLI

Guides

Tooling

Using Merge Proposals

Prerequisites