| Name | stack-pr JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Stacked PR CLI for Github |
| upload_time | 2024-10-17 23:02:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | ============================================================================================== The stack-pr repository is licensed under the Apache License v2.0 with LLVM Exceptions: ============================================================================================== Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---- LLVM Exceptions to the Apache 2.0 License ---- As an exception, if, as a result of your compiling your source code, portions of this Software are embedded into an Object form of such source code, you may redistribute such embedded portions in such Object form without complying with the conditions of Sections 4(a), 4(b) and 4(d) of the License. In addition, if you combine or link compiled forms of this Software with software that is licensed under the GPLv2 ("Combined Software") and if a court of competent jurisdiction determines that the patent provision (Section 3), the indemnity provision (Section 9) or other Section of the License conflicts with the conditions of the GPLv2, you may retroactively and prospectively choose to deem waived or otherwise exclude such Section(s) of the License, but only in their entirety and only with respect to the Combined Software. ============================================================================== Software from third parties included in the LLVM Project: ============================================================================== The LLVM Project contains third party software which is under different license terms. All such code will be identified clearly using at least one of two mechanisms: 1) It will be in a separate directory tree with its own `LICENSE.txt` or `LICENSE` file at the top containing the specific license and restrictions which apply to that software, or 2) It will contain specific license and restriction terms at the top of every file. |
| keywords |
stacked-prs
github
pull-requests
stack-pr
git
version-control
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Stacked PRs for GitHub
This is a command-line tool that helps you create multiple GitHub
pull requests (PRs) all at once, with a stacked order of dependencies.
Imagine that we have a change `A` and a change `B` depending on `A`, and we
would like to get them both reviewed. Without stacked PRs one would have to
create two PRs: `A` and `A+B`. The second PR would be difficult to review as it
includes all the changes simultaneously. With stacked PRs the first PR will
have only the change `A`, and the second PR will only have the change `B`. With
stacked PRs one can group related changes together making them easier to
review.
Example:
## Dependencies
This is a non-comprehensive list of dependencies required by `stack-pr.py`:
- Install `gh`, e.g., `brew install gh` on MacOS.
- Run `gh auth login` with SSH
## Installation
To install via [pipx](https://pipx.pypa.io/stable/) run:
```bash
pipx install stack-pr
```
Manually, you can clone the repository and run the following command:
```bash
pipx install .
```
## Workflow
`stack-pr` is a tool allowing you to work with stacked PRs: submit,
view, and land them.
The `stack-pr` tool has four commands:
- `submit` (or `export`) - create a new stack of PRs from the given set of
commits. One can think of this as “push my local changes to the corresponding
remote branches and update the corresponding PRs (or create new PRs if they
don’t exist yet)”.
- `view` - inspect the given set of commits and find the linked PRs. This
command does not push any changes anywhere and does not change any commits.
It can be used to examine what other commands did or will do.
- `abandon` - remove all stack metadata from the given set of commits. Apart
from removing the metadata from the affected commits, this command deletes
the corresponding local and remote branches and closes the PRs.
- `land` - merge PRs from the stack corresponding to the given set of commits.
This command attempts to merge PRs from the stack one by one, and if
succeeded deletes the corresponding branches from local and remote repos.
A usual workflow is the following:
```bash
while not ready to merge:
make local changes
commit to local git repo or amend existing commits
create or update the stack with `stack-pr.py submit`
merge changes with `stack-pr.py land`
```
You can also use `view` at any point to examine the current state, and
`abandon` to drop the stack.
Under the hood the tool creates and maintains branches named
`$USERNAME/stack/$BRANCH_NUM` and embeds stack metadata into commit messages,
but you are not supposed to work with those branches or edit that metadata
manually. I.e. instead of pushing to these branches you should use `submit`,
instead of deleting them you should use `abandon` and instead of merging them
you should use `land`.
The tool looks at commits in the range `BASE..HEAD` and creates a stack of PRs
to apply these commits to `TARGET`. By default, `BASE` is `main` (local
branch), `HEAD` is the git revision `HEAD`, and `TARGET` is `main` on remote
(i.e. `origin/main`). These parameters can be changed with options `-B`, `-H`,
and `-T` respectively and accept the standard git notation: e.g. one can use
`-B HEAD~2`, to create a stack from the last two commits.
### Example
The first step before creating a stack of PRs is to double-check the changes
we’re going to post.
By default the tool will look at commits in `main..HEAD` range and will create
a PR for every commit in that range.
For instance, if we have
```bash
# git checkout my-feature
# git log -n 4 --format=oneline
**cc932b71c** (**my-feature**) Optimized navigation algorithms for deep space travel
**3475c898f** Fixed zero-gravity coffee spill bug in beverage dispenser
**99c4cd9a7** Added warp drive functionality to spaceship engine.
**d2b7bcf87** (**origin/main, main**) Added module for deploying remote space probes
```
Then the tool will consider the top three commits as changes, for which we’re
trying to create a stack.
> **Pro-tip**: a convenient way to see what commits will be considered by
> default is the following command:
>
```bash
alias githist='git log --abbrev-commit --oneline $(git merge-base origin/main HEAD)^..HEAD'
```
We can double-check that by running the script with `view` command - it is
always a safe command to run:
```bash
# stack-pr view
...
VIEW
**Stack:**
* **cc932b71** (No PR): Optimized navigation algorithms for deep space travel
* **3475c898** (No PR): Fixed zero-gravity coffee spill bug in beverage dispenser
* **99c4cd9a** (No PR): Added warp drive functionality to spaceship engine.
SUCCESS!
```
If everything looks correct, we can now submit the stack, i.e. create all the
corresponding PRs and cross-link them. To do that, we run the tool with
`submit` command:
```bash
# stack-pr submit
...
SUCCESS!
```
The command accepts a couple of options that might be useful, namely:
- `--draft` - mark all created PRs as draft. This helps to avoid over-burdening
CI.
- `--draft-bitmask` - mark select PRs in a stack as draft using a bitmask where
`1` indicates draft, and `0` indicates non-draft.
For example `--draft-bitmask 0010` to make the third PR a draft in a stack
of four.
The length of the bitmask must match the number of stacked PRs.
Overridden by `--draft` when passed.
- `--reviewer="handle1,handle2"` - assign specified reviewers.
If the command succeeded, we should see “SUCCESS!” in the end, and we can now
run `view` again to look at the new stack:
```python
# stack-pr view
...
VIEW
**Stack:**
* **cc932b71** (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel
* **3475c898** (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser
* **99c4cd9a** (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.
SUCCESS!
```
We can also go to github and check our PRs there:
If we need to make changes to any of the PRs (e.g. to address the review
feedback), we simply amend the desired changes to the appropriate git commits
and run `submit` again. If needed, we can rearrange commits or add new ones.
When we are ready to merge our changes, we use `land` command.
```python
# stack-pr land
LAND
Stack:
* cc932b71 (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel
* 3475c898 (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser
* 99c4cd9a (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.
Landing 99c4cd9a (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.
...
Rebasing 3475c898 (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser
...
Rebasing cc932b71 (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel
...
SUCCESS!
```
This command lands the first PR of the stack and rebases the rest. If we run
`view` command after `land` we will find the remaining, not yet-landed PRs
there:
```python
# stack-pr view
VIEW
**Stack:**
* **8177f347** (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel
* **35c429c8** (#438, 'ZolotukhinM/stack/102' -> 'main'): Fixed zero-gravity coffee spill bug in beverage dispenser
```
This way we can land all the PRs from the stack one by one.
## Specifying custom commit ranges
The example above used the default commit range - `main..HEAD`, but you can
specify a custom range too. Below are several commonly useful invocations of
the script:
```bash
# Submit a stack of last 5 commits
stack-pr submit -B HEAD~5
# Use 'origin/main' instead of 'main' as the base for the stack
stack-pr submit -B origin/main
# Do not include last two commits to the stack
stack-pr submit -H HEAD~2
```
These options work for all script commands (and it’s recommended to first use
them with `view` to double check the result). It is possible to mix and match
them too - e.g. one can first submit the stack for the last 5 commits and then
land first three of them:
```bash
# Inspect what commits will be included HEAD~5..HEAD
stack-pr view -B HEAD~5
# Create a stack from last five commits
stack-pr submit -B HEAD~5
# Inspect what commits will be included into the range HEAD~5..HEAD~2
stack-pr view -B HEAD~5 -H HEAD~2
# Land first three PRs from the stack
stack-pr land -B HEAD~5 -H HEAD~2
```
## Command Line Options Reference
The section is not added yet, contributions are welcome!
### Config files
Default values for command line options can be specified via a config file.
Path to the config file can be specified via `STACKPR_CONFIG` envvar, and by
default it's assumed to be `.stack-pr.cfg` in the current folder.
An example of a config file:
```cfg
[common]
verbose=True
hyperlinks=True
draft=False
keep_body=False
[repo]
remote=origin
target=main
reviewer=GithubHandle1,GithubHandle2
branch_name_template=$USERNAME/$BRANCH
```
Raw data
{
"_id": null,
"home_page": null,
"name": "stack-pr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Modular Inc <hello@modular.com>",
"keywords": "stacked-prs, github, pull-requests, stack-pr, git, version-control",
"author": null,
"author_email": "Modular Inc <hello@modular.com>",
"download_url": "https://files.pythonhosted.org/packages/84/9e/4edcbadf6640c5fb30a5b3828f6fb5f14ab0021da0438af60ed19f97620b/stack_pr-0.1.3.tar.gz",
"platform": null,
"description": "# Stacked PRs for GitHub\n\nThis is a command-line tool that helps you create multiple GitHub\npull requests (PRs) all at once, with a stacked order of dependencies.\n\nImagine that we have a change `A` and a change `B` depending on `A`, and we\nwould like to get them both reviewed. Without stacked PRs one would have to\ncreate two PRs: `A` and `A+B`. The second PR would be difficult to review as it\nincludes all the changes simultaneously. With stacked PRs the first PR will\nhave only the change `A`, and the second PR will only have the change `B`. With\nstacked PRs one can group related changes together making them easier to\nreview.\n\nExample:\n\n\n## Dependencies\n\nThis is a non-comprehensive list of dependencies required by `stack-pr.py`:\n\n- Install `gh`, e.g., `brew install gh` on MacOS.\n- Run `gh auth login` with SSH\n\n## Installation\n\nTo install via [pipx](https://pipx.pypa.io/stable/) run:\n\n```bash\npipx install stack-pr\n```\n\nManually, you can clone the repository and run the following command:\n\n```bash\npipx install .\n```\n\n## Workflow\n\n`stack-pr` is a tool allowing you to work with stacked PRs: submit,\nview, and land them.\n\nThe `stack-pr` tool has four commands:\n\n- `submit` (or `export`) - create a new stack of PRs from the given set of\n commits. One can think of this as \u201cpush my local changes to the corresponding\n remote branches and update the corresponding PRs (or create new PRs if they\n don\u2019t exist yet)\u201d.\n- `view` - inspect the given set of commits and find the linked PRs. This\n command does not push any changes anywhere and does not change any commits.\n It can be used to examine what other commands did or will do.\n- `abandon` - remove all stack metadata from the given set of commits. Apart\n from removing the metadata from the affected commits, this command deletes\n the corresponding local and remote branches and closes the PRs.\n- `land` - merge PRs from the stack corresponding to the given set of commits.\n This command attempts to merge PRs from the stack one by one, and if\n succeeded deletes the corresponding branches from local and remote repos.\n\nA usual workflow is the following:\n\n```bash\nwhile not ready to merge:\n make local changes\n commit to local git repo or amend existing commits\n create or update the stack with `stack-pr.py submit`\nmerge changes with `stack-pr.py land`\n```\n\nYou can also use `view` at any point to examine the current state, and\n`abandon` to drop the stack.\n\nUnder the hood the tool creates and maintains branches named\n`$USERNAME/stack/$BRANCH_NUM` and embeds stack metadata into commit messages,\nbut you are not supposed to work with those branches or edit that metadata\nmanually. I.e. instead of pushing to these branches you should use `submit`,\ninstead of deleting them you should use `abandon` and instead of merging them\nyou should use `land`.\n\nThe tool looks at commits in the range `BASE..HEAD` and creates a stack of PRs\nto apply these commits to `TARGET`. By default, `BASE` is `main` (local\nbranch), `HEAD` is the git revision `HEAD`, and `TARGET` is `main` on remote\n(i.e. `origin/main`). These parameters can be changed with options `-B`, `-H`,\nand `-T` respectively and accept the standard git notation: e.g. one can use\n`-B HEAD~2`, to create a stack from the last two commits.\n\n### Example\n\nThe first step before creating a stack of PRs is to double-check the changes\nwe\u2019re going to post.\n\nBy default the tool will look at commits in `main..HEAD` range and will create\na PR for every commit in that range.\n\nFor instance, if we have\n\n```bash\n# git checkout my-feature\n# git log -n 4 --format=oneline\n**cc932b71c** (**my-feature**) Optimized navigation algorithms for deep space travel\n**3475c898f** Fixed zero-gravity coffee spill bug in beverage dispenser\n**99c4cd9a7** Added warp drive functionality to spaceship engine.\n**d2b7bcf87** (**origin/main, main**) Added module for deploying remote space probes\n\n```\n\nThen the tool will consider the top three commits as changes, for which we\u2019re\ntrying to create a stack.\n\n> **Pro-tip**: a convenient way to see what commits will be considered by\n> default is the following command:\n>\n\n```bash\nalias githist='git log --abbrev-commit --oneline $(git merge-base origin/main HEAD)^..HEAD'\n```\n\nWe can double-check that by running the script with `view` command - it is\nalways a safe command to run:\n\n```bash\n# stack-pr view\n...\nVIEW\n**Stack:**\n * **cc932b71** (No PR): Optimized navigation algorithms for deep space travel\n * **3475c898** (No PR): Fixed zero-gravity coffee spill bug in beverage dispenser\n * **99c4cd9a** (No PR): Added warp drive functionality to spaceship engine.\nSUCCESS!\n```\n\nIf everything looks correct, we can now submit the stack, i.e. create all the\ncorresponding PRs and cross-link them. To do that, we run the tool with\n`submit` command:\n\n```bash\n# stack-pr submit\n...\nSUCCESS!\n```\n\nThe command accepts a couple of options that might be useful, namely:\n\n- `--draft` - mark all created PRs as draft. This helps to avoid over-burdening\n CI.\n- `--draft-bitmask` - mark select PRs in a stack as draft using a bitmask where\n `1` indicates draft, and `0` indicates non-draft.\n For example `--draft-bitmask 0010` to make the third PR a draft in a stack\n of four.\n The length of the bitmask must match the number of stacked PRs.\n Overridden by `--draft` when passed.\n- `--reviewer=\"handle1,handle2\"` - assign specified reviewers.\n\nIf the command succeeded, we should see \u201cSUCCESS!\u201d in the end, and we can now\nrun `view` again to look at the new stack:\n\n```python\n# stack-pr view\n...\nVIEW\n**Stack:**\n * **cc932b71** (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel\n * **3475c898** (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser\n * **99c4cd9a** (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.\nSUCCESS!\n```\n\nWe can also go to github and check our PRs there:\n\n\n\nIf we need to make changes to any of the PRs (e.g. to address the review\nfeedback), we simply amend the desired changes to the appropriate git commits\nand run `submit` again. If needed, we can rearrange commits or add new ones.\n\nWhen we are ready to merge our changes, we use `land` command.\n\n```python\n# stack-pr land\nLAND\nStack:\n * cc932b71 (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel\n * 3475c898 (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser\n * 99c4cd9a (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.\nLanding 99c4cd9a (#437, 'ZolotukhinM/stack/101' -> 'main'): Added warp drive functionality to spaceship engine.\n...\nRebasing 3475c898 (#438, 'ZolotukhinM/stack/102' -> 'ZolotukhinM/stack/101'): Fixed zero-gravity coffee spill bug in beverage dispenser\n...\nRebasing cc932b71 (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel\n...\nSUCCESS!\n```\n\nThis command lands the first PR of the stack and rebases the rest. If we run\n`view` command after `land` we will find the remaining, not yet-landed PRs\nthere:\n\n```python\n# stack-pr view\nVIEW\n**Stack:**\n * **8177f347** (#439, 'ZolotukhinM/stack/103' -> 'ZolotukhinM/stack/102'): Optimized navigation algorithms for deep space travel\n * **35c429c8** (#438, 'ZolotukhinM/stack/102' -> 'main'): Fixed zero-gravity coffee spill bug in beverage dispenser\n```\n\nThis way we can land all the PRs from the stack one by one.\n\n## Specifying custom commit ranges\n\nThe example above used the default commit range - `main..HEAD`, but you can\nspecify a custom range too. Below are several commonly useful invocations of\nthe script:\n\n```bash\n# Submit a stack of last 5 commits\nstack-pr submit -B HEAD~5\n\n# Use 'origin/main' instead of 'main' as the base for the stack\nstack-pr submit -B origin/main\n\n# Do not include last two commits to the stack\nstack-pr submit -H HEAD~2\n```\n\nThese options work for all script commands (and it\u2019s recommended to first use\nthem with `view` to double check the result). It is possible to mix and match\nthem too - e.g. one can first submit the stack for the last 5 commits and then\nland first three of them:\n\n```bash\n# Inspect what commits will be included HEAD~5..HEAD\nstack-pr view -B HEAD~5\n# Create a stack from last five commits\nstack-pr submit -B HEAD~5\n\n# Inspect what commits will be included into the range HEAD~5..HEAD~2\nstack-pr view -B HEAD~5 -H HEAD~2\n# Land first three PRs from the stack\nstack-pr land -B HEAD~5 -H HEAD~2\n```\n\n## Command Line Options Reference\nThe section is not added yet, contributions are welcome!\n\n### Config files\nDefault values for command line options can be specified via a config file.\nPath to the config file can be specified via `STACKPR_CONFIG` envvar, and by\ndefault it's assumed to be `.stack-pr.cfg` in the current folder.\n\nAn example of a config file:\n\n```cfg\n[common]\nverbose=True\nhyperlinks=True\ndraft=False\nkeep_body=False\n[repo]\nremote=origin\ntarget=main\nreviewer=GithubHandle1,GithubHandle2\nbranch_name_template=$USERNAME/$BRANCH\n```\n",
"bugtrack_url": null,
"license": "============================================================================================== The stack-pr repository is licensed under the Apache License v2.0 with LLVM Exceptions: ============================================================================================== Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---- LLVM Exceptions to the Apache 2.0 License ---- As an exception, if, as a result of your compiling your source code, portions of this Software are embedded into an Object form of such source code, you may redistribute such embedded portions in such Object form without complying with the conditions of Sections 4(a), 4(b) and 4(d) of the License. In addition, if you combine or link compiled forms of this Software with software that is licensed under the GPLv2 (\"Combined Software\") and if a court of competent jurisdiction determines that the patent provision (Section 3), the indemnity provision (Section 9) or other Section of the License conflicts with the conditions of the GPLv2, you may retroactively and prospectively choose to deem waived or otherwise exclude such Section(s) of the License, but only in their entirety and only with respect to the Combined Software. ============================================================================== Software from third parties included in the LLVM Project: ============================================================================== The LLVM Project contains third party software which is under different license terms. All such code will be identified clearly using at least one of two mechanisms: 1) It will be in a separate directory tree with its own `LICENSE.txt` or `LICENSE` file at the top containing the specific license and restrictions which apply to that software, or 2) It will contain specific license and restriction terms at the top of every file. ",
"summary": "Stacked PR CLI for Github",
"version": "0.1.3",
"project_urls": {
"Bug tracker": "https://github.com/modularml/stack-pr/issues",
"Homepage": "https://github.com/modularml/stack-pr",
"Repository": "https://github.com/modularml/stack-pr"
},
"split_keywords": [
"stacked-prs",
" github",
" pull-requests",
" stack-pr",
" git",
" version-control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dd5aa80c48526a28c5c9dd2e325dd6541a690e897ac7c4e184b5d39973a217e",
"md5": "f268ec86fc055030d4c5d1153b1587d5",
"sha256": "5c6228cde93a8a0df6508d3ed5cebd6927f9691a2f81373dcfc63783df88735d"
},
"downloads": -1,
"filename": "stack_pr-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f268ec86fc055030d4c5d1153b1587d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 28888,
"upload_time": "2024-10-17T23:02:19",
"upload_time_iso_8601": "2024-10-17T23:02:19.281608Z",
"url": "https://files.pythonhosted.org/packages/6d/d5/aa80c48526a28c5c9dd2e325dd6541a690e897ac7c4e184b5d39973a217e/stack_pr-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "849e4edcbadf6640c5fb30a5b3828f6fb5f14ab0021da0438af60ed19f97620b",
"md5": "a160b0ede3a5a243b37a0baf84d3906d",
"sha256": "ece0debfb42e7b3ed328415555f6a9e5cdceadc64dca6742debbe9078ebd4eab"
},
"downloads": -1,
"filename": "stack_pr-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "a160b0ede3a5a243b37a0baf84d3906d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 30476,
"upload_time": "2024-10-17T23:02:20",
"upload_time_iso_8601": "2024-10-17T23:02:20.943309Z",
"url": "https://files.pythonhosted.org/packages/84/9e/4edcbadf6640c5fb30a5b3828f6fb5f14ab0021da0438af60ed19f97620b/stack_pr-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 23:02:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "modularml",
"github_project": "stack-pr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stack-pr"
}
