Code Monkey home page Code Monkey logo

gha-sync-fork's Introduction

gha-sync-fork

A GitHub action to sync a forked repo's branch with an upstream repo's branch

Overview

The fork's changes are rebased on top of any missing commits from the upstream repository. If there are merge conflicts, this action will fail until the conflicts are manually resolved. If there are no changes between the fork and upstream, no work is done. By default, the fork's entire commit history is fetched because this action doesn't know how many new commits the fork has received.

.github/workflows/test.yml

Usage

An example workflow that runs this action:

- name: Sync my project
  uses: thebrowsercompany/gha-sync-fork
  with:
    fork_repo: myuser/project
    fork_branch: main
    upstream_repo: otheruser/project
    upstream_branch: main

Inputs

fork_repo:
  description: The repository to update.
  required: false

fork_branch:
  description: The branch to update.
  required: true

upstream_repo:
  description: The repository to pull changes from.
  required: true

upstream_branch:
  description: The branch to pull changes from.
  required: true

upstream_host:
  description: The upstream repository URL host, if not github.com.
  required: false
  default: 'github.com'

dry_run:
  description: If true, changes are not pushed to the fork.
  required: false
  default: false

gha-sync-fork's People

Contributors

kendalharland avatar

Stargazers

Jasdev Singh avatar avatar

Watchers

Hursh Agrawal avatar Andrew Monshizadeh avatar Josh Miller avatar Samir Mody avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.