[GitHub] metron pull request #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

Github user nickwallen closed the pull request at:

https://github.com/apache/metron/pull/902


---

[GitHub] metron issue #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

Github user nickwallen commented on the issue:

https://github.com/apache/metron/pull/902
  
Also, I've never liked the name `prepare-commit`.  If you guys can think of 
something better, please let me know.


---

[GitHub] metron pull request #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

GitHub user nickwallen reopened a pull request:

https://github.com/apache/metron/pull/902

METRON-1413 Add Metron Commit Tool

This PR contributes the `prepare-merge` tool that many (some?) contributors 
use.  Up until now, it has been managed in a separate repo.

I didn't have a logical place to put this tool, so I had to reorganize a 
bit.  Since our tooling has been growing, a reorganization shouldn't be too 
unexpected.

* Creates top level directory called `dev-utilities`.
* Moves existing `build_utils` to `dev-utilities/build-utils`
* Moves existing `build_utils/release-utils` to 
`dev-utilities/release-utils`
* Creates `dev-utilities/committer-utils`
* Adds the `prepare-commit` script to `committer-utils`.

It is a bit easier to see by just looking at it.
```
dev-utilities/
├── build-utils
│   ├── README.md
│   ├── create_bundled_licenses.sh
│   ├── generate_license.py
│   ├── list_dependencies.sh
│   ├── verify_license.py
│   └── verify_licenses.sh
├── committer-utils
│   ├── README.md
│   └── prepare-commit
└── release-utils
├── metron-rc-check
└── validate-jira-for-release

3 directories, 10 files
```

## Pull Request Checklist

- [x] Is there a JIRA ticket associated with this PR? If not one needs to 
be created at [Metron 
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
 
- [x] Does your PR title start with METRON- where  is the JIRA 
number you are trying to resolve? Pay particular attention to the hyphen "-" 
character.
- [x] Has your PR been rebased against the latest commit within the target 
branch (typically master)?


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/nickwallen/metron METRON-1413

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/metron/pull/902.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #902


commit 44494212f1fd78e212d15a72f142c9b7534b46f8
Author: Nick Allen 
Date:   2018-01-19T17:28:42Z

METRON-1413 Add Metron Commit Tool

commit 098f90bc7fee5e2ab016470b02fee28c06f0f71e
Author: Nick Allen 
Date:   2018-01-19T17:57:52Z

Added license to README

commit 3ba733ca497f74b21625419e54757e6ac95c0bdd
Author: Nick Allen 
Date:   2018-01-19T18:06:38Z

Fixed typo

commit 9835faac9b814cb7e3c7f3142c79b55bf41bfec1
Author: Nick Allen 
Date:   2018-01-19T19:10:52Z

Renamed to dev-utilities

commit 8e981bb6ee246a45c07c93b41494b484ff66b0e3
Author: Nick Allen 
Date:   2018-01-19T20:18:46Z

Fixed-up references to build_utils




---

[GitHub] metron issue #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

Github user nickwallen commented on the issue:

https://github.com/apache/metron/pull/902
  
Travis had a hickup... Doing the "close/reopen" dance to trigger the CI 
build.


---

[GitHub] metron issue #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

Github user nickwallen commented on the issue:

https://github.com/apache/metron/pull/902
  
The Apache ID isn't really necessary to use `prepare-commit`.  What if I 
just changed the docs to note that it is not required?  I could document how 
you could use the script to review a PR.

I would like to try and fill the need that you've identified 
@ottobackwards, I just really want to keep the amount of code that we have to 
maintain and support as minimal as possible.  


 


---

[GitHub] metron issue #902: METRON-1413 Add Metron Commit Tool

[nickwallen]

Github user nickwallen commented on the issue:

https://github.com/apache/metron/pull/902
  
> @JonZeolla: ... the curl command HTML encodes the JIRA description but I 
don't know of a clean bash-native way to decode it.

Yes, I have noticed, especially with apostrophes.  When that happens, I 
usually just manually override it as a work around.  

My goal was just to get the tool into Apache as-is (warts and all).  We can 
try and fix annoyances like that on subsequent PRs (IMHO).  

I know you have some enhancements that you would like to make also.  
Looking forward to those. :)



---