Repository files navigation

🤖 a GitHub App that keeps your forks up-to-date with upstream via automatedpull requests.

Can you help keep this open source service alive?💖 Please sponsor : )

• 🔄Automated Synchronization: Ensures forks are updated by automaticallycreating pull requests to integrate new changes from upstream
• ⚙️Flexible Configuration: Customize sync behavior through.github/pull.yml configuration to accommodate different merge strategies,including merge, squash, rebase, and hard reset
• 🕒Scheduled Updates: Regularly checks for upstream changes periodicallyto ensure forks are always up-to-date
• 👥Team Integration: Facilitates collaboration by automatically addingassignees and reviewers to pull requests, honoring branch protection rules andworking seamlessly with pull request checks and reviews
• 🚀Enterprise Ready: Supports GitHub Enterprise Server, ensuring a smoothintegration process for enterprise-level projects

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

⭐ Star this project (Highly recommended, starred users mayreceive priority over other users)

• Just install Pull app.

Pull app will automatically watch and pull in upstream's default (master) branchto yours usinghard reset periodically. You can also manuallytrigger it anytime.

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:masterupstream:wei:master# change `wei` to the owner of upstream repomergeMethod:hardreset

   Advanced usage

   version:"1"rules:# Array of rules  -base:master# Required. Target branchupstream:wei:master# Required. Must be in the same fork network.mergeMethod:hardreset# Optional, one of [none, merge, squash, rebase, hardreset], Default: none.mergeUnstable:false# Optional, merge pull request even when the mergeable_state is not clean. Default: false  -base:devupstream:master# Required. Can be a branch in the same forked repo.assignees:# Optional      -weireviewers:# Optional      -weiconflictReviewers:# Optional, on merge conflict assign a reviewer      -weilabel:":arrow_heading_down: pull"# OptionalconflictLabel:"merge-conflict"# Optional, on merge conflict assign a custom label, Default: merge-conflict

4. Go tohttps://pull.git.ci/check/${owner}/${repo} to validate your.github/pull.yml.

5. Install Pull app.

You can manually trigger Pull by going tohttps://pull.git.ci/process/${owner}/${repo}.

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

Example (assumingowner is your user or organization name):

version:"1"rules:  -base:masterupstream:owner:mastermergeMethod:hardreset  -base:docsupstream:owner:docsmergeMethod:hardreset

SeeCONTRIBUTING.md

MIT ©Wei He

Can you help keep this open source service alive?💖 Please sponsor : )

Made with ❤️ by@wei