Developer Manual
This page contains instructions for DiscourseDB developers including DevOps details. Users of DiscourseDB should might want to look at the other pages provided in this wiki, in particular the general overview and setup page.
You can find instructions for how to set up eclipse for DiscourseDB development in this document
DiscourseDB Core is a multi-module maven project in a single Git repository. The root folder contains the parent pom which is responsible for project-wide dependency management and for defining the sub-modules that belong to DiscourseDB Core. It is also the pom that is read by the continuous integration system (CI) and determines what is being built on a regular basis.
To create a new module in eclipse, (1) check out DiscourseDB Core, (2) right click on the discoursedb-core project (3) select Maven > New Maven Module Project. Then follow the instructions. This will create a new module project and add it to the modules in the parent pom.
Whenever new code is pushed to GitHub, Jenkins starts a new build of DiscourseDB. This is not done via SCM polling, but with a GitHub web hook. If the build succeeds, the new snapshot artifacts are automatically deployed to Artifactory and from then on available to developers. Furthermore, the javadoc documentation is automatically updated.
Jenkins is configured to keep up to 100 builds and provides statistics, style checks and bug analyses for each of them.
Before creating a new release, make sure the current snapshot does not have any snapshot dependencies. If a module has a snapshot dependency, either replace it with a stable version or - if not possible, exclude the module from the release (i.e. remove the module from the core pom, commit, release, add module back to the core pom in the new snapshot).
Once the codebase is ready to be release, login to Jenkins with the discoursedb admin account and select the DiscourseDB job. In the menu on the left, select "Artifactory Release Staging". You can now adapt the release information, if necessary (optional). Then click on "Build and Release to Artifactory". Jenkins automatically changes the artifact versions to the new release version, builds the codebase, creates a release branch, deploys the release artifacts to artifactory and changes the versions in the master branch to the new snapshot version. When this process completes, the release process is finished (since we do not split the process into "staging" and "promotion") There is no need to promote the release nor is it possible with the non-pro Artifactory.
Note: Releases are created by the GitHub user "discoursedbcmu".
 Step 1 |
 Step 2 |
 Step 3 |