https://github.com/TreTuna/sync-branches

GitHub Action to sync back a branch to another after a merge.
https://github.com/TreTuna/sync-branches

Last synced: 3 months ago
JSON representation

GitHub Action to sync back a branch to another after a merge.

• Host: GitHub
• URL: https://github.com/TreTuna/sync-branches
• Owner: TreTuna
• License: mit
• Created: 2020-02-15T07:19:42.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-20T12:06:28.000Z (5 months ago)
• Last Synced: 2024-07-25T20:19:49.835Z (3 months ago)
• Language: JavaScript
• Size: 626 KB
• Stars: 105
• Watchers: 1
• Forks: 55
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - TreTuna/sync-branches - GitHub Action to sync back a branch to another after a merge. (JavaScript)

README

        
# sync-branches

GitHub Action to sync one branch when another is updated.

## Inputs

### `GITHUB_TOKEN`

**Required** The token to be used for creating the pull request. Can be set to the one given for the workflow or another user.

### `FROM_BRANCH`

**Required** The branch you want to make the pull request from.

### `TO_BRANCH`

**Required** The branch you want to make the pull request to.

### `PULL_REQUEST_TITLE`

What you would like as the title of the pull request.

Default: `sync: {FROM_BRANCH} to {TO_BRANCH}`

### `PULL_REQUEST_BODY`

What you would like in the body of the pull request.

Default: `sync-branches: New code has just landed in {FROM_BRANCH} so let's bring {TO_BRANCH} up to speed!`

### `PULL_REQUEST_IS_DRAFT`

Set to `true` for the pull request to be opened as a draft.

Default: `false`

### `CONTENT_COMPARISON`

Set to `true` to force checking content comparison between branches.

No more empty pull requests being opened and triggering CI jobs.

Default: `false`

### `REVIEWERS`

JSON array of GitHub user `login`s that will be requested to review the PR.

Example: `'["tretuna"]'`

Default: `[]`

### `TEAM_REVIEWERS`

JSON array of GitHub team `slug`s that will be requested to review the PR.

Example: `'["js-team"]'`

Default: `[]`

### `PULL_REQUEST_AUTO_MERGE_METHOD`

Set a merge method for auto merging.

Options: `merge`, `squash`, `rebase`

Default: `false`

## Outputs

### `PULL_REQUEST_URL`

Set to the URL of either the pull request that was opened by this action or the one that was found to already be open between the two branches

### `PULL_REQUEST_NUMBER`

Pull request number from generated pull request or the currently open one

## Example usage

```YML

name: Sync

on:

  push:

    branches:

      - main

jobs:

  sync-branches:

    runs-on: ubuntu-latest

    name: Syncing branches

    steps:

      - name: Checkout

        uses: actions/checkout@v2

      - name: Set up Node

        uses: actions/setup-node@v1

        with:

          node-version: 12

      - name: Opening pull request

        id: pull

        uses: tretuna/[email protected]

        with:

          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

          FROM_BRANCH: "main"

          TO_BRANCH: "develop"

```