Pull

🤖 a GitHub App built with probot that keeps your repository up-to-date with upstream changes via automated pull requests.

Features

1. A pull request is created when an upstream is updated (checks periodically).
2. Pull requests can be automatically merged or hard reset to match upstream.

Upstream must be in the same fork network

Setup

⚠️Before you start: Create a new branch if you have made changes to your fork's default (master) branch.

Basic setup (without config):

1. Run git clone --mirror to make a backup (Recommended if you have made changes).
2. Install Pull app.
3. With zero-configuration, Pull app will automatically watch and pull in upstream's default (master) branch to yours with hard reset.

💡Do NOT touch default (master) branch in any forks. Always create new branches to work on.

Recommended setup (with config):

1. Run git clone --mirror to make a backup (optional).
2. Create a new branch.
3. Setup the new branch as default branch under repository Settings > Branches.
4. Add .github/pull.yml to your default branch.

Most common

(Basic setup default)

version: "1"
rules:
  - head: master
    upstream: wei:master        # change wei to the owner of upstream repo
    autoMerge: true
    autoMergeHardReset: true

Advanced usage

version: "1"
rules:                           # Array of rules
  - head: master                 # Required. Target branch
    upstream: wei:master         # Required. Must be in the same fork network.
    autoMerge: true              # Optional, Default: false
    autoMergeHardReset: true     # Optional, Default: false DANGEROUS Wipes target branch changes and reset ref to match upstream
  - head: dev
    upstream: master
    assignees:                   # Optional
      - wei
    reviewers:                   # Optional
      - wei
label: ":arrow_heading_down: pull"       # Optional

5. Go to https://pull.now.sh/check/:owner/:repo to validate your .github/pull.yml.
6. Install Pull app.

For Repository Owners

If you have a popular repo with a fork network, consider adding .github/pull.yml to your repository pointing to yourself (see example). This will allow forks to install Pull and stay updated with zero-configuration.

Example (assuming owner is your user or organization name):

version: "1"
rules:
  - head: master
    upstream: owner:master
    autoMerge: true
    autoMergeHardReset: true
  - head: docs
    upstream: owner:docs
    autoMerge: true
    autoMergeHardReset: true

Author

Wei He github@weispot.com

License

MIT