action-sync-branch

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

action-sync-branch

★ 17 Open GitHub ↗

GitHub Action to keep a branch in sync with the current branch

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sync Branch

GitHub Action to keep a branch in sync with the current branch

</div>

## Usage

Here's an example workflow that syncs a `test` branch every time a commit is pushed to the `main` branch:

```yml
name: Sync branch

on:
  push:
    branches:
      - main

permissions:
  contents: write

jobs:
  sync-branch:
    name: Update test branch
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

- uses: connor-baer/action-sync-branch@v2
        with:
          branch: test
          token: ${{ secrets.GITHUB_TOKEN }}
          force: false
```

## Inputs

### `branch`

**Required** The name of the branch to sync with the current branch.

### `token`

**Required** A GitHub token with permission to push to the repo. [Generate a new token](https://github.com/settings/tokens/new?description=Sync%20Branch&scopes=repo).

### `force`

Whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. Default: `false`.

action-sync-branch

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README