Merge pull request #113 from VariantSync/develop

Release 2.1.0

Author: pmbittner

.github/workflows/maven.yml

@@ -17,17 +17,17 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Install Nix with cached packages
-      uses: rikhuijzer/cache-install@v1.1.1
+      uses: rikhuijzer/cache-install@v.1.1.3
       with:
-        key: nix-${{ hashFiles('.github/workflows/maven.yml', 'default.nix', 'nix/**') }}
+        key: nix-${{ hashFiles('.github/workflows/maven.yml', 'default.nix', 'nix/**', 'pom.xml', 'local-maven-repo') }}
         nix_file: nix/github-workflow-dependencies.nix
     - name: Build
       run: nix-build
     - name: Upload Javadoc artifact
       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:

.run/EditClassValidation.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="EditClassValidation" type="Application" factoryName="Application" nameIsGenerated="true">
     <option name="MAIN_CLASS_NAME" value="org.variantsync.diffdetective.validation.EditClassValidation" />
-    <module name="diffdetective" />
+    <module name="DiffDetective" />
     <method v="2">
       <option name="Make" enabled="true" />
     </method>

.run/GenAutomationResults.run.xml

@@ -1,9 +1,8 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="GenAutomationResults" type="Application" factoryName="Application">
     <option name="ALTERNATIVE_JRE_PATH" value="openjdk-16" />
-    <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
     <option name="MAIN_CLASS_NAME" value="org.variantsync.diffdetective.validation.FindMedianCommitTime" />
-    <module name="diffdetective" />
+    <module name="DiffDetective" />
     <option name="PROGRAM_PARAMETERS" value="results/validation/current" />
     <extension name="coverage">
       <pattern>

.run/GenUltimateResults.run.xml

@@ -1,9 +1,8 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="GenUltimateResults" type="Application" factoryName="Application">
     <option name="ALTERNATIVE_JRE_PATH" value="openjdk-16" />
-    <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
     <option name="MAIN_CLASS_NAME" value="org.variantsync.diffdetective.tablegen.MiningResultAccumulator" />
-    <module name="diffdetective" />
+    <module name="DiffDetective" />
     <option name="PROGRAM_PARAMETERS" value="results/validation/current results/validation/current" />
     <extension name="coverage">
       <pattern>

README.md

@@ -8,17 +8,29 @@
       inherit system;
     },
   doCheck ? true,
-  buildJavadoc ? true,
+  buildGitHubPages ? true,
 }:
 pkgs.stdenv.mkDerivation rec {
   pname = "DiffDetective";
-  version = "2.0.0";
-  src = ./.;
+  version = "2.1.0";
+  src = with pkgs.lib.fileset;
+    toSource {
+      root = ./.;
+      # This should be `gitTracked ./.`. However, this currently doesn't accept
+      # shallow repositories as used in GitHub CI.
+      fileset =
+        (import (sources.nixpkgs + "/lib/fileset/internal.nix") {inherit (pkgs) lib;})._fromFetchGit
+        "gitTracked"
+        "argument"
+        ./.
+        {shallow = true;};
+    };
 
   nativeBuildInputs = with pkgs; [
     maven
     makeWrapper
     graphviz
+    (ruby.withPackages (pkgs: with pkgs; [github-pages jekyll-theme-cayman]))
   ];
 
   mavenRepo = pkgs.stdenv.mkDerivation {
@@ -45,17 +57,27 @@ pkgs.stdenv.mkDerivation rec {
     dontConfigure = true;
     outputHashAlgo = "sha256";
     outputHashMode = "recursive";
-    outputHash = "sha256-qIKFqNwooJ0iqzkv6TTS5GM4bA6iYkVa35zqE+q5izY=";
+    outputHash = "sha256-jQxZ6eSokwM6bP/vHkYczhE7xW/rHS/IH4pGy2SzzH0=";
   };
 
   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
   '';
@@ -74,15 +96,13 @@ pkgs.stdenv.mkDerivation rec {
 
     local jar="$out/share/java/DiffDetective/DiffDetective.jar"
     install -Dm644 "target/diffdetective-${version}-jar-with-dependencies.jar" "$jar"
-    makeWrapper "${pkgs.maven.jdk}/bin/java" "$out/bin/DiffDetective" --add-flags "-cp \"$jar\"" \
+    makeWrapper "${pkgs.jdk}/bin/java" "$out/bin/DiffDetective" --add-flags "-cp \"$jar\"" \
       --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 ""
     }

default.nix

@@ -0,0 +1,4 @@
+# A simple script for deploying an update of the functjonal library to the local maven repository
+# The script takes a single argument, the path to the functjonal jar file to deploy
+mvn deploy:deploy-file -DgroupId=org.variantsync -DartifactId=functjonal -Dversion=1.0-SNAPSHOT -Durl=file:../local-maven-repo/ -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile=$1
+rm -rf ~/.m2/repository/org/variantsync/functjonal/