Generate GitHub pages

Author: ibbem

.github/workflows/maven.yml

@@ -27,7 +27,7 @@ jobs:
       if: ${{ github.event_name == 'push' && github.event.ref == 'refs/heads/main' }}
       uses: actions/upload-pages-artifact@v1
       with:
-        path: result/share/doc/DiffDetective
+        path: result/share/github-pages
 
   # An additional job is recommened in the documentation of `actions/deploy-pages`
   deploy-javadoc:

README.md

@@ -140,6 +140,6 @@ DiffDetective was extended and used within bachelor's and master's theses:
 - _Inspecting the Evolution of Feature Annotations in Configurable Software_, Lukas Güthing, Master's Thesis, 2023: Lukas implemented different edge-types for associating variability annotations within variation diffs. He published his work later at VaMoS 2024 under the title _Explaining Edits to Variability Annotations in Evolving Software Product Lines_, illustrated above.
 - _Empirical Evaluation of Feature Trace Recording on the Edit History of Marlin_, Sören Viegener, Bachelor's Thesis, 2021, [DOI 10.18725/OPARU-38603](http://dx.doi.org/10.18725/OPARU-38603): In his thesis, Sören started the DiffDetective project and implemented the first version of an algorithm, which parses text-based diffs to C-preprocessor files to variation diffs. He also came up with an initial classification of edits, which we wanted to reuse to evaluate [Feature Trace Recording](https://variantsync.github.io/FeatureTraceRecording/), a method for deriving variability annotations from annotated patches.
 
-[documentation]: https://htmlpreview.github.io/?https://github.com/VariantSync/DiffDetective/blob/splc23-views/docs/javadoc/index.html
+[documentation]: https://variantsync.github.io/DiffDetective/docs/javadoc
 [website]: https://variantsync.github.io/DiffDetective/
 [forklg]: https://github.com/guethilu/DiffDetective

default.nix

@@ -8,7 +8,7 @@
       inherit system;
     },
   doCheck ? true,
-  buildJavadoc ? true,
+  buildGitHubPages ? true,
 }:
 pkgs.stdenv.mkDerivation rec {
   pname = "DiffDetective";
@@ -30,6 +30,7 @@ pkgs.stdenv.mkDerivation rec {
     maven
     makeWrapper
     graphviz
+    (ruby.withPackages (pkgs: with pkgs; [github-pages jekyll-theme-cayman]))
   ];
 
   mavenRepo = pkgs.stdenv.mkDerivation {
@@ -62,11 +63,21 @@ pkgs.stdenv.mkDerivation rec {
   buildPhase = ''
     runHook preBuild
 
-    mvn --offline -Dmaven.repo.local="$mavenRepo" -Dmaven.test.skip=true clean package ${
-      if buildJavadoc
-      then "javadoc:javadoc"
+    mvn() {
+      command mvn --offline -Dmaven.repo.local="$mavenRepo" "$@"
+    }
+
+    ${
+      # Build the documentation before the code because we don't want to include
+      # the generated files in the GitHub Pages
+      if buildGitHubPages
+      then ''
+        mvn javadoc:javadoc
+        PAGES_REPO_NWO=VariantSync/DiffDetective JEKYLL_BUILD_REVISION= github-pages build
+      ''
       else ""
     }
+    mvn -Dmaven.test.skip=true clean package
 
     runHook postBuild
   '';
@@ -89,11 +100,9 @@ pkgs.stdenv.mkDerivation rec {
       --prefix PATH : "${pkgs.graphviz}"
 
     ${
-      if buildJavadoc
+      if buildGitHubPages
       then ''
-        local doc="$out/share/doc"
-        mkdir -p "$doc"
-        cp -r docs/javadoc "$doc/DiffDetective"
+        cp -r _site "$out/share/github-pages"
       ''
       else ""
     }