Grouper Javadoc, cross-referenced source code, and other project and module reports are at http://software.internet2.edu/grouper/doc/ . The active Git branch is updated on the 3rd and 18th of every month by a cron job on i2midev6 (service user grprdist) , and pulled via rsync to webprod3. The same site can also be built locally from the script in Git grouper/misc/buildJavadocAll.sh. Or, the simple Maven command mvn -f grouper-parent --clean site site-deploy
will be enough to generate the site. The site
directive will build the site locally in a subdirectory of grouper-parent, and site-deploy
will stage it in directory /tmp/groupersite.
Reports available for each release module include:
Document | Description |
---|---|
Javadoc | Javadoc API documentation. |
Test Javadoc | Test Javadoc API documentation. |
Source Xref | HTML based, cross-reference version of Java source code. |
Test Source Xref | HTML based, cross-reference version of Java test source code. |
Dependency Updates Report | Provides details of the dependencies which have updated versions available. |
Plugin Updates Report | Provides details of the plugins used by this project which have newer versions available. |
Property Updates Report | Provides details of properties which control versions of dependencies and/or plugins, and indicates any newer versions which are available. |
Tag List | Report on various tags found in the code. |
dependency-check:aggregate | Generates an aggregate report of all child Maven projects providing details on any published vulnerabilities within project dependencies. This report is a best effort and may contain false positives and false negatives. |
Between 2014 and 2019, the git branch gh-pages
was updated with the javadoc on every commit, which effectively published it on http://internet2.github.io/grouper/ . That method has been decommissioned due to the size explosion in the git repository. The main page of the github.io site now redirects to the software.internet2.edu site.