...
(2) Documents
We use Sphinx to automatically generate detailed documentation on our scripts/libraries. Please follow the link below to see more details about this.
Documenting The SeisFinder2 ProjectGenerating API Documentation with Sphinx
(
23) Jenkins CI
We use Jenkins CI for automated testing to run from hypocentre.
Currently Jenkins is running in hypocentre (with tmux). This service can be started manually by running the war file as shown below.
Once jenkins started, open a browser and enter http://hypocentre:8081
. Enter the admin login credentials.
It has a list of projects which are the test builds. Click on a project and click build now to manually start a test build.
...
In Configure -> Click Build -> Click Add Build Step -> Choose Execute shell
. In the Command, mention the path to your the runscript.
In Configure -> Click Post-Build Actions -> Click Add Post-Build Action -> Choose Publish JUnit test result report
The above step is for the xml test reports. The The following setup is required to send out emails after every build.
In Configure -> Click Post-Build Actions -> Click Add Post-Build Action -> Choose Editable Email Notification
Click Advanced Settings -> Click Add Trigger -> Choose Always
...
Leave the rest to default. Now the project is configured to run every friday from getting the latest code from git. the test results will be emailed to the recipients automatically.