feat: first working version

Author: stevearc-stripe

.envrc

@@ -0,0 +1 @@
+layout python

.github/workflows/tests.yml

@@ -0,0 +1,56 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Running tests for ${{ matrix.python-version }} with tox
+        uses: ymyzk/run-tox-gh-actions@main
+
+  release:
+    name: release
+    if: ${{ github.ref == 'refs/heads/master' }}
+    needs:
+      - test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: simple
+          package-name: gitstack
+      - uses: actions/checkout@v3
+      - uses: rickstaa/action-create-tag@v1
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          tag: stable
+          message: "Current stable release: ${{ steps.release.outputs.tag_name }}"
+          tag_exists_error: false
+          force_push_tag: true
+      - run: sed -i 's/"dev"/"${{ steps.release.outputs.tag_name }}"/' gitstack.py
+      - uses: actions/upload-release-asset@v1
+        if: ${{ steps.release.outputs.release_created }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          upload_url: ${{ steps.release.outputs.upload_url }}
+          asset_path: gitstack.py
+          asset_name: gitstack.py
+          asset_content_type: text/x-script.python

.gitignore

@@ -158,3 +158,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.direnv/

.pylintrc

@@ -0,0 +1,14 @@
+[MESSAGES CONTROL]
+disable=E1101,W0511,W0612,W0613,W0212,W0221,W0703,W0622,W1510,C,R
+
+[BASIC]
+argument-rgx=[a-z_][a-z0-9_]{0,30}$
+variable-rgx=[a-z_][a-z0-9_]{0,30}$
+function-rgx=[a-z_][a-z0-9_]{0,30}$
+attr-rgx=[a-z_][a-z0-9_]{0,30}$
+method-rgx=([a-z_][a-z0-9_]{0,50}|setUp|tearDown|setUpClass|tearDownClass)$
+no-docstring-rgx=((__.*__)|setUp|tearDown)$
+
+[REPORTS]
+reports=no
+msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}

README.md

@@ -1 +1,50 @@
-# gitstack
+# gitstack
+
+A utility for stacking branch and github pull requests
+
+- [Installation](#installation)
+- [Quick start](#quick-start)
+- [Concepts](#concepts)
+- [Why gitstack](#why-gitstack)
+
+## Installation
+
+```bash
+curl -L https://github.com/stevearc/gitstack/releases/latest/download/gitstack.py -o ~/.local/share/gitstack.py
+git config --global alias.stack '!python ~/.local/share/gitstack.py'
+```
+
+Now you can use these commands with `git stack`. Feel free to shorten the alias to something quicker to type.
+
+## Quick start
+
+```bash
+# create a branch and make commits as normal
+git stack create --split  # create a new branch for each commit
+git stack pr              # create pull requests for each branch
+git stack publish         # publish the pull requests
+# go to github and add summary, reviewers, test plan, etc
+
+# If changes are requested:
+git stack first           # check out the branch for the first PR
+# make fixes
+git commit -am "fixes"   # add new commits for fixes
+git push
+# optionally, you can restack the rest of the branches
+git stack restack
+# optionally, you can force push the restacked branches
+git stack push -f -a
+```
+
+You can always learn more about the commands with `git stack -h` or `git stack <cmd> -h`.
+
+## Concepts
+
+gitstack is just trying to automate the work that you would have to do yourself. There is no magic, just a lot of rebasing branches onto other branches.
+However, it _does_ need to keep track of how the branches are stacked in order to do a proper restack. To do this, **gitstack adds a `prev-branch: <branch>` label to the commit message of the first commit in a branch**. This is the _only_ data that gitstack stores anywhere, and you should feel empowered to edit it by hand if you like.
+
+`git stack create` will turn the current linear history of branches into a stack, overriding any previous stack. If you need to reorder branches, insert new ones, or make other changes, do so with normal git commands and then re-run `git stack create`.
+
+## Why gitstack
+
+I have found all other tools I have tried to be excessively magic. They make use of storing information locally, which makes it hard to sync a stack and work on it from another machine, or they require you to always interact with the stack using their commands. This tool does the minimal amount possible to improve stacking ergonomics, and then gets out of your way. You're still able to use raw git commands like usual.