You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@crunch.apache.org by "Matthias Friedrich (JIRA)" <ji...@apache.org> on 2012/07/11 20:41:34 UTC
[jira] [Created] (CRUNCH-15) Add reports to Maven site
Matthias Friedrich created CRUNCH-15:
----------------------------------------
Summary: Add reports to Maven site
Key: CRUNCH-15
URL: https://issues.apache.org/jira/browse/CRUNCH-15
Project: Crunch
Issue Type: Task
Reporter: Matthias Friedrich
Decide which reports are useful and add them to the site. Options:
* Cobertura
* Checkstyle
* PMD
* FindBugs
* JDepend
* Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CRUNCH-15) Add reports to Maven site
Posted by "Matthias Friedrich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Matthias Friedrich updated CRUNCH-15:
-------------------------------------
Attachment: checkstyle.xml
Attaching my preliminary checkstyle config.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Rahul Sharma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414919#comment-13414919 ]
Rahul Sharma commented on CRUNCH-15:
------------------------------------
You need to execute site:stage command. site:site just generates the pages of individual modules. When they get deployed using the deploy or stage goal they get connected with one another. This is explain here : http://maven.apache.org/plugins/maven-site-plugin/examples/multimodule.html
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Matthias Friedrich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414722#comment-13414722 ]
Matthias Friedrich commented on CRUNCH-15:
------------------------------------------
Rahul, I can't commit anything, so I attached my checkstyle config to this issue :)
Applying the patch works better now using "git am 0001-adding-reporting.patch", there are just a few whitespace warnings. You can catch this by running "git status --check" after making changes to your working copy but before adding the modified files to the index. Also, you should configure your full name and mail address with git so that you are properly credited. I found these instructions helpful: https://help.github.com/articles/set-up-git
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CRUNCH-15) Add reports to Maven site
Posted by "Rahul Sharma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rahul Sharma updated CRUNCH-15:
-------------------------------
Attachment: 0001-adding-site-reporting.patch
ah!! my mistake, should have done that while attaching patch. I am attaching the patch again with the grant.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Josh Wills (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414788#comment-13414788 ]
Josh Wills commented on CRUNCH-15:
----------------------------------
Hey guys-- which patches are ready to go here? I don't mind fixing whitespace issues.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Josh Wills (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13415209#comment-13415209 ]
Josh Wills commented on CRUNCH-15:
----------------------------------
Thanks Rahul-- I committed the patches. Unfortunately, I didn't check first to ensure that you had given permission to the ASF to include them when you attached them to the page. Would you mind re-adding the 0001-adding-site-reporting.patch file and clicking the checkbox that gives permission to include the code in Apache projects?
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CRUNCH-15) Add reports to Maven site
Posted by "Rahul Sharma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rahul Sharma updated CRUNCH-15:
-------------------------------
Attachment: 0001-adding-reporting.patch
I have included javadoc reporting also for each of the projects. The report will be generated for public APIs only. I thinks these are the external interfaces and rest of the things are internal to the system.
@Matthias : If you can commit the checkstyle xml I can update the patch to use that.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CRUNCH-15) Add reports to Maven site
Posted by "Rahul Sharma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rahul Sharma updated CRUNCH-15:
-------------------------------
Attachment: report-gen.patch
I have created a patch that will publish Cobertura and Checkstyle reports for all the individual modules. The Checkstyle currently uses the default xml as the customized one could not be found in repo. Moreover, the site has been modified to display different modules. I feel when you have multiple modules which are kind of nonindependent then is a better way of presenting information. I have not included other reports as I feel the two are good enough, but maybe that's just my way. If people feel that more reporting is required I would update the configuration.
PS : I am pretty new to git business, let me know if there are any issues with patch.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (CRUNCH-15) Add reports to Maven site
Posted by "Josh Wills (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Josh Wills resolved CRUNCH-15.
------------------------------
Resolution: Fixed
Fix Version/s: 0.3.0
Thanks Rahul!
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Fix For: 0.3.0
>
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Josh Wills (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414910#comment-13414910 ]
Josh Wills commented on CRUNCH-15:
----------------------------------
Whitespace issues aren't a big deal-- when I run mvn site:site, the target/site/index.html page doesn't link to the index.html pages under crunch/target/site and scrunch/target/site. Is that a bug, or do I need to run some other command?
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (CRUNCH-15) Add reports to Maven site
Posted by "Matthias Friedrich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414595#comment-13414595 ]
Matthias Friedrich commented on CRUNCH-15:
------------------------------------------
Rahul, that's a good idea, different modules on the site level make things much easier. What do you think about adding a Javadoc report, too?
Regarding the patch: The patch tool complains that it's reversed and it seems in crunch/pom the indenting changed from spaces to tabs. I struggled a while with git, eventually I found instructions that work well: https://git-wip-us.apache.org/docs/workflow.html (you have to replace "origin/trunk" with "origin/master" though).
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CRUNCH-15) Add reports to Maven site
Posted by "Rahul Sharma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rahul Sharma updated CRUNCH-15:
-------------------------------
Attachment: 0001-adding-site-reporting.patch
I have included the checkstyle in the patch. Also updated the patch to display breadcrumbs according to site tree.
I have added index page for every module. The scale module had README that was used for index page. The crunch core shows the repeated info from the landing page and the example page is still empty. Maybe we can add some specific info for each of them.
PS : I think the patch would have some whitespace warnings. I tried to fix all of them but I dont think that I was completely successful. Let me know if there some issues.
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, 0001-adding-site-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Comment Edited] (CRUNCH-15) Add reports to Maven site
Posted by "Matthias Friedrich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CRUNCH-15?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13414722#comment-13414722 ]
Matthias Friedrich edited comment on CRUNCH-15 at 7/15/12 5:53 PM:
-------------------------------------------------------------------
Rahul, I can't commit anything, so I attached my checkstyle config to this issue :)
Applying the patch works better now using "git am 0001-adding-reporting.patch", there are just a few whitespace warnings. You can catch this by running "git diff --check" after making changes to your working copy but before adding the modified files to the index. Also, you should configure your full name and mail address with git so that you are properly credited. I found these instructions helpful: https://help.github.com/articles/set-up-git
was (Author: mafr):
Rahul, I can't commit anything, so I attached my checkstyle config to this issue :)
Applying the patch works better now using "git am 0001-adding-reporting.patch", there are just a few whitespace warnings. You can catch this by running "git status --check" after making changes to your working copy but before adding the modified files to the index. Also, you should configure your full name and mail address with git so that you are properly credited. I found these instructions helpful: https://help.github.com/articles/set-up-git
> Add reports to Maven site
> -------------------------
>
> Key: CRUNCH-15
> URL: https://issues.apache.org/jira/browse/CRUNCH-15
> Project: Crunch
> Issue Type: Task
> Reporter: Matthias Friedrich
> Attachments: 0001-adding-reporting.patch, checkstyle.xml, report-gen.patch
>
>
> Decide which reports are useful and add them to the site. Options:
> * Cobertura
> * Checkstyle
> * PMD
> * FindBugs
> * JDepend
> * Project info reports: http://maven.apache.org/plugins/maven-project-info-reports-plugin/
> Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira