Metadata-Version: 2.1
Name: ghstack
Version: 0.0.13
Summary: Stack diff support for GitHub
Home-page: https://github.com/pypa/ghexport
Author: Edward Z. Yang
Author-email: ezyang@mit.edu
License: UNKNOWN
Description: # ghstack
        
        Conveniently submit stacks of diffs to GitHub as separate pull requests.
        
        ```
        pip install ghstack
        ```
        
        ## How to use
        
        Prepare a series of commits on top of master, then run `ghstack`.  This
        tool will push and create individuals for each PR on the stack.
        
        **WARNING.**  You will NOT be able to merge these commits using the
        normal UI method, as their branch bases won't be master.
        
        ## Structure of submitted pull requests
        
        Every commit in your local commit stack gets submitted into a separate
        pull request and pushes commits onto three branches:
        
        * `gh/username/1/base` - think of this like "master": it's the base
          branch that your commit was based upon.  It is never force pushed;
          whenever you rebase your local stack, we add merge commits on top of
          base from the true upstream master.
        
        * `gh/username/1/head` - this branch is your change, on top of the base
          branch.  Like base, it is never force pushed.  We open a pull request
          on this branch, requesting to merge into base.
        
        * `gh/username/1/orig` - this is the actual commit as per your local
          copy.  GitHub pull requests never sees this commit, but if you want
          to get a "clean" commit all by itself, this is an easy way to get it.
        
        ## Developer notes
        
        We have tests, using a mock GitHub GraphQL server!  How cool is that?
        Run these tests using `python test_ghstack.py`
        
        ## Design constraints
        
        There are some weird aspects about GitHub's design which lead to unusual
        design decisions on this tool.
        
        1. When you create a PR on GitHub, you cannot subsequently change which
           repository it merges into (you can change which branch merges into).
           This means you have a hard choice when designing a tool like this:
           if you want to target the topmost PR to master, you must push
           branches onto the origin repo; if you give up on this, you can push
           branches into a fork.  We've decided to give up targets to master so
           that we can push the branches to your fork.
        
           (Actually, this is a lie; we still push to origin lol.)
        
        2. Branch name does not correspond to pull request number. While this
           would be excellent, we have no way of reserving a pull request
           number, so we have no idea what it's going to be until we open
           the pull request, but we can't open the pull request without a
           branch.
        
        ## Ripley Cupboard
        
        Channeling Conor McBridge, this section documents mistakes worth
        mentioning.
        
        **Non-stack mode.**  ghstack processes your entire stack when it
        uploads updates, but it doesn't have to be that way; you could
        imagine that you could ask ghstack to only process the topmost
        commit and leave the rest alone.  An easy and attractive
        looking way of doing this is to edit the stack selection algorithm
        to look a single commit, rather than all the commits from
        merge-base to head.
        
        This sounds OK but you try it and you realize two things:
        
        1. This is wrong, if you exclude the commits before your commit
           you'll end up with a base commit based on the "literal"
           commit in your Git repository.  But this has no relationship
           with the base commit that was previously uploaded, which
           was synthetically constructed.
        
        2. You also have do extra work to pull out an up to date stack
           to write into the pull request body.
        
        So, this is not impossible to do, but it will need some work.
        You have to work out what the real base commit is, whether
        or not you need to advance it, and also rewrite the stack rendering
        code.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
