Skip to content

Commit

Permalink
Merge pull request #1534 from jlowin/pr-tool-2
Browse files Browse the repository at this point in the history
  • Loading branch information
jlowin committed May 25, 2016
2 parents ac96fbf + 6d87679 commit 7332c40
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 91 deletions.
5 changes: 2 additions & 3 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ It is very important that PRs reference a JIRA issue. The preferred way to do th

__Please note:__ this tool will restore your current branch when it finishes, but you will lose any uncommitted changes. Make sure you commit any changes you wish to keep before proceeding.

Also, do not run this tool from inside the `dev` folder if you are working with a PR that predates the `dev` directory. It will be unable to restore itself from a nonexistent location. Run it from the main airflow directory instead: `dev/airflow-pr`.

### Execution
Simply execute the `airflow-pr` tool:
Expand All @@ -28,6 +27,7 @@ Options:
--help Show this message and exit.
Commands:
close_jira Close a JIRA issue (without merging a PR)
merge Merge a GitHub PR into Airflow master
work_local Clone a GitHub PR locally for testing (no push)
```
Expand All @@ -38,8 +38,7 @@ Execute `airflow-pr merge` to be interactively guided through the process of mer

Execute `airflow-pr work_local` to only merge the PR locally. The tool will pause once the merge is complete, allowing the user to explore the PR, and then will delete the merge and restore the original development environment.

Both commands can be followed by a PR number (`airflow-pr merge 42`); otherwise the tool will prompt for one.

Execute `airflow-pr close_jira` to close a JIRA issue without needing to merge a PR. You will be prompted for an issue number and close comment.

### Configuration

Expand Down
Loading

0 comments on commit 7332c40

Please sign in to comment.