Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.3.0
    • Component/s: None
    • Labels:
      None

      Description

      Decide which reports are useful and add them to the site. Options:

      Note that this issue depends on CRUNCH-12 and that Checkstyle probably needs extensive configuration.

      1. 0001-adding-reporting.patch
        15 kB
        Rahul Sharma
      2. 0001-adding-site-reporting.patch
        45 kB
        Rahul Sharma
      3. 0001-adding-site-reporting.patch
        45 kB
        Rahul Sharma
      4. checkstyle.xml
        5 kB
        Matthias Friedrich
      5. report-gen.patch
        26 kB
        Rahul Sharma

        Activity

        Hide
        Rahul Sharma added a comment -

        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.

        Show
        Rahul Sharma added a comment - 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.
        Hide
        Matthias Friedrich added a comment -

        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).

        Show
        Matthias Friedrich added a comment - 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).
        Hide
        Rahul Sharma added a comment -

        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.

        Show
        Rahul Sharma added a comment - 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.
        Hide
        Matthias Friedrich added a comment -

        Attaching my preliminary checkstyle config.

        Show
        Matthias Friedrich added a comment - Attaching my preliminary checkstyle config.
        Hide
        Matthias Friedrich added a comment - - edited

        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

        Show
        Matthias Friedrich added a comment - - edited 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
        Hide
        Josh Wills added a comment -

        Hey guys-- which patches are ready to go here? I don't mind fixing whitespace issues.

        Show
        Josh Wills added a comment - Hey guys-- which patches are ready to go here? I don't mind fixing whitespace issues.
        Hide
        Rahul Sharma added a comment -

        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.

        Show
        Rahul Sharma added a comment - 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.
        Hide
        Josh Wills added a comment -

        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?

        Show
        Josh Wills added a comment - 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?
        Hide
        Rahul Sharma added a comment -

        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

        Show
        Rahul Sharma added a comment - 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
        Hide
        Josh Wills added a comment -

        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?

        Show
        Josh Wills added a comment - 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?
        Hide
        Rahul Sharma added a comment -

        ah!! my mistake, should have done that while attaching patch. I am attaching the patch again with the grant.

        Show
        Rahul Sharma added a comment - ah!! my mistake, should have done that while attaching patch. I am attaching the patch again with the grant.
        Hide
        Josh Wills added a comment -

        Thanks Rahul!

        Show
        Josh Wills added a comment - Thanks Rahul!
        Hide
        Josh Wills added a comment -

        Close out 0.3.0 issues.

        Show
        Josh Wills added a comment - Close out 0.3.0 issues.

          People

          • Assignee:
            Unassigned
            Reporter:
            Matthias Friedrich
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development