[BUILD-24] Improvements/cleanup of readme files Created: 28/Oct/09 Updated: 13/Apr/17 Resolved: 20/Nov/10 |
|
| Status: | Closed |
| Project: | Build |
| Component/s: | Poms |
| Affects Version/s: | None |
| Fix Version/s: | Build Tools 1.5.6, Module Assembly 1.2.5, POMs 18 |
| Type: | Improvement | Priority: | Major |
| Reporter: | Magnolia International | Assignee: | Magnolia International |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||
| Template: |
|
||||||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||||||
| Description |
|
From Current build-tools' README depend a lot on the artifact type to determine what information to put in the README files etc. One of the most visible flaws is that is the artifact is of type pom, the README will say this bundle includes Tomcat, which is not always desirable (i.e STK is not bundled with Tomcat). Another possible improvement would be to remove the "If an INSTALL.txt [...]" bit conditionally. Probably not possible without a lot of work to print it only if the file exists, but we could remove it if the docu url is provided. And... do we use this at all? |
| Comments |
| Comment by Magnolia International [ 18/Nov/10 ] |
|
This could be solved either by patching the remote-resources plugin (which currently blindly copies all files), or perhaps by manually configure the target/magnolia-build-tools-resources folder (instead of letting the remote-res plugin copy all of it) |