Skip to content
git-merge

GitHub Action

backports-gitflow-action

0.0.5 Latest version

backports-gitflow-action

git-merge

backports-gitflow-action

A GitHub Action that automatically creates and merges pull requests between specified branches

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: backports-gitflow-action

              
  uses: MegaverseBE/[email protected]
Learn more about this action in MegaverseBE/backports-gitflow-action

Choose a version

Gitflow Action

This action will automatically merge your master branch into dev and release into master through the creation of pull requests that will be automatically merged, if possible and enabled.
Those pull requests will be identified by a label named gitflow as default.

Setting up

Create a file named .github/workflows/gitflow.yml.

Minimal configuration

name: Gitflow
on: 
  # To create pull requests.
  push:
  # To merge pull requests if not possible during the push run. Remove if `auto-merge` is `false`.
  pull_request_review:
  check_run:
    types: [completed]
    
jobs:
  build:
    name: Gitflow
    runs-on: ubuntu-latest
    steps:
    - uses: MegaverseBE/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.

Disabled auto merge

name: Gitflow
on: 
  # To create pull requests.
  - push 

jobs:
  build:
    name: Gitflow
    runs-on: ubuntu-latest
    steps:
    - uses: MegaverseBE/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
        auto-merge: false # If `true`, will try to automatically merge the pull requests.

Complete configuration

All values are default.

name: Gitflow
on: 
  # To create pull requests.
  push:
  # To merge pull requests if not possible during the push run. Remove if `auto-merge` is `false`.
  pull_request_review:
  check_run:
    types: [completed]

jobs:
  build:
    name: Gitflow
    runs-on: ubuntu-latest
    steps:
    - uses: MegaverseBE/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
        release: release # The `release` branch.
        dev: dev # The `dev` branch.
        master: master # The `master` branch.
        label: gitflow # The pull request label.
        auto-merge: true # If `true`, will try to automatically merge pull requests. Can also be set to `pull_request_review`, `check_run`, `push`, or a comma-separated combination of these values to only merge when handling the named events.
        require-merge: false # If an attempted merge fails, the action is considered to have failed.

Auto update

You can use (at your own risk) the release branch instead of the specific version tag.
Never user master, since the distribution file does not exist in this branch and the action will always fail.

Changelog

Click here.

Contributing

If you have suggestions for how close-label could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.