Pull

Keep your forks up-to-date.

Table of Contents

• Introduction
• Features
  • Prerequisites
• Getting Started
  • Basic Setup
  • Advanced Setup (with config)
    • Most Common
    • Advanced usage
• For Repository Owners
• Author
• License

Introduction

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

Incorporate new changes as they happen, not in 6 months.

Trusted by repositories, triggered times.

Features

• Ensure forks are updated.
• Automatically integrate new changes from upstream.
• Pull requests are created when upstreams are updated.
• Automatically merge or hard reset pull requests to match upstream.
• Add assignees and reviewers to pull requests.
• Customize pull request label.
• Honor branch protection rules.
• Work well with pull request checks and reviews.

Prerequisites

• Upstream must be in the same fork network.
• ⚠️ Make a backup if you've made changes.

Getting Started

Basic Setup

• Just install Pull app.

Pull app will automatically watch and pull in upstream's default (master) branch to yours with hard reset.

Advanced Setup (with config)

1. Create a new branch.
2. Setup the new branch as default branch under repository Settings > Branches.
3. Add .github/pull.yml to your default branch.

Most Common

(behaves the same as Basic Setup)

version: "1"
rules:
  - base: master
    upstream: wei:master      # change `wei` to the owner of upstream repo
    autoMerge: true
    autoMergeHardReset: true
    autoMergeRebase: false

Advanced usage

version: "1"
rules:                        # Array of rules
  - base: 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
    autoMergeRebase: false    # Optional, Default: false 
  - base: dev
    upstream: master          # Required. Can be a branch in the same forked repo.
    assignees:                # Optional
      - wei
    reviewers:                # Optional
      - wei
label: ":arrow_heading_down: pull"  # Optional

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

For Repository Owners

For the most common use case (a single master branch), you can just direct users to install Pull with no configurations. If you need a more advanced setup (such as a docs branch in addition to master), consider adding .github/pull.yml to your repository pointing to yourself (see example). This will allow forks to install Pull and stay updated automatically.

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

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

Author

Wei He [email protected]

License

MIT