[ODLPARENT-22] Automatically include README and CONTRIBUTING file in jar Created: 13/Aug/15 Updated: 03/Jul/18 Resolved: 03/Jul/18 |
|
| Status: | Resolved |
| Project: | odlparent |
| Component/s: | General |
| Affects Version/s: | None |
| Fix Version/s: | 2.0.0 |
| Type: | Improvement | ||
| Reporter: | Thanh Ha (zxiiro) | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
Operating System: All |
||
| Issue Links: |
|
||||||||
| Description |
|
We should automatically include README and CONTRIBUTING files to the final jar output for all jars. This feature should provide a default README and CONTRIBUTING file however if the project repo contains these files we should instead provide the project provided versions of these files instead. This feature suggestion was provided via mailing list thread here: https://lists.opendaylight.org/pipermail/release/2015-July/003258.html |
| Comments |
| Comment by Thanh Ha (zxiiro) [ 05/Oct/15 ] |
| Comment by Daniel Farrell [ 09/Oct/15 ] |
|
imho, these are good example CONTRIBUTING docs: https://github.com/dfarrell07/ansible-opendaylight/blob/master/CONTRIBUTING.md |
| Comment by Thanh Ha (zxiiro) [ 06/Jan/16 ] |
|
Finally got around to doing this here's patches I submitted to releng/builder and releng/autorelease. https://git.opendaylight.org/gerrit/31851 I think it's a short and decent start that we can push to all projects. They can then modify and update as they see fit. I'll start pushing similar patches to all Beryllium projects. |
| Comment by Michael Vorburger [ 19/Jul/16 ] |
|
In addition how about we also use this bug to include the "project metadata" PROJECT_INFO.yaml file (to be) placed in the root of each project repo's, which will include committer and contributor names? Then we could have a generic <developer> entry in the parent pom.xml, which points to that. Thoughts? |
| Comment by Thanh Ha (zxiiro) [ 19/Jul/16 ] |
|
(In reply to Michael Vorburger from comment #4) Sounds good to me. |
| Comment by Michael Vorburger [ 23/Jul/16 ] |
|
https://git.opendaylight.org/gerrit/#/c/42370/ with https://git.opendaylight.org/gerrit/#/c/42052/ Done? |