Reorganize and refurbish .gitignore file

Does not work, unfortunately

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build
+
+on:
+  push:
+    paths:
+      - .github/workflows/build.yml
+      - build.gradle
+      - settings.gradle
+      - src/**
+      - launcher/build.gradle
+      - launcher/src/**
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: antville
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Compile with Gradle
+        run: ./gradlew :compileJava

.github/workflows/deploy.yml

@@ -4,19 +4,12 @@ on: workflow_dispatch
 
 jobs:
   deploy:
-    runs-on: ubuntu-latest
+    runs-on: antville
 
     environment:
-      name: weblogs.at
-      url: https://weblogs.at
+      name: antville.org
+      url: https://antville.org
 
     steps:
-      - name: Set up SSH agent
-        uses: antville/helma/.github/actions/ssh@helma-🐜
-        with:
-          config: ${{ vars.SSH_CONFIG }}
-          key: ${{ secrets.SSH_PRIVATE_KEY }}
-          known-hosts: ${{ vars.SSH_KNOWN_HOSTS }}
-
       - name: Copy files to production server
         run: ssh staging-server deploy-helma

.github/workflows/release.yml

@@ -1,45 +1,59 @@
 name: Release
 
 on:
+  workflow_dispatch:
   push:
-    tags:
-      - 'v*'
+    tags: '2*'
 
 permissions:
   contents: write
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  release:
+    runs-on: antville
 
     env:
-      GH_TOKEN: ${{ github.token }}
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
       LC_TIME: en_US.UTF-8
 
     steps:
       - uses: actions/checkout@v4
-
-      - name: Set up Java
-        uses: actions/setup-java@v4
         with:
-          distribution: temurin
-          java-version: 21
+          fetch-depth: 0
 
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
+      - name: Create release notes
+        id: create_release_notes
+        run: |
+          release_notes=$(npx git-cliff@latest --latest)
+          # Write the release notes as a heredoc to the workflow output
+          # ⚠️ No white space around `<<` is crucial!
+          echo "release_notes<<.eot0x03" >> $GITHUB_OUTPUT
+          echo "$release_notes" >> $GITHUB_OUTPUT
+          echo ".eot0x03" >> $GITHUB_OUTPUT
 
       - name: Build with Gradle
         run: ./gradlew assembleDist
 
       - name: Create release
+        uses: actions/forgejo-release@v2
+        with:
+          direction: upload
+          url: https://code.host.antville.org
+          token: ${{ github.token }}
+          title: Helma ${{ github.ref_name }}
+          release-dir: build/distributions
+          release-notes: ${{ steps.create_release_notes.outputs.release_notes }}
+          verbose: true
+
+      - name: Create release at GitHub
         run: |
           gh release create "$GITHUB_REF_NAME" \
             --repo "$GITHUB_REPOSITORY" \
-            --title "$(date +'%d %b %Y')" \
-            --generate-notes
+            --title "Helma ${{ github.ref_name }}" \
+            --notes "${{ steps.create_release_notes.outputs.release_notes }}"
 
-      - name: Upload assets
+      - name: Upload release assets to GitHub
         run: |
-          gh release upload "$GITHUB_REF_NAME" \
-            build/distributions/helma-*.* \
+          gh release upload "$GITHUB_REF_NAME" build/distributions/helma-*.* \
+            --repo "$GITHUB_REPOSITORY" \
             --clobber

.github/workflows/renovate.yml

@@ -0,0 +1,44 @@
+name: Run Renovate
+
+on:
+  schedule:
+    - cron: "13 * * * *"
+  workflow_dispatch:
+
+jobs:
+  renovate:
+    runs-on: antville
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run Renovate
+        # See <https://docs.renovatebot.com/troubleshooting/#log-debug-levels>
+        # debug | info | warn | error | fatal
+        run: LOG_LEVEL=info npx renovate
+        env:
+          # Renovate is using this token to retrieve release notes
+          GITHUB_COM_TOKEN: ${{ secrets.renovate_github_com_token }}
+          # Autodiscover is better suited for an extra repo running Renovate on all desired repos
+          #RENOVATE_AUTODISCOVER: 'true'
+          RENOVATE_CONFIG_FILE: renovate.json
+          RENOVATE_ENDPOINT: ${{ github.api_url }}
+          RENOVATE_GIT_AUTHOR: Renovate Bot <mail+renovate@antville.org>
+          #RENOVATE_GIT_IGNORED_AUTHORS:
+          #  - 29139614+renovate[bot]@users.noreply.github.com
+          RENOVATE_IGNORE_PR_AUTHOR: 'true'
+          RENOVATE_LOG_FILE: renovate-log.ndjson
+          RENOVATE_LOG_FILE_LEVEL: debug
+          RENOVATE_PLATFORM: gitea
+          RENOVATE_REPOSITORIES: ${{ github.repository }}
+          RENOVATE_REPOSITORY_CACHE: 'enabled'
+          # github.token is not working here, it lacks some permissions required by Renovate
+          RENOVATE_TOKEN: ${{ secrets.renovate_token }}
+
+      - name: Save log file
+        # FIXME: v4 of this action causes an error on Forgejo (“You must configure a GitHub token”)
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: renovate-log.ndjson
+          path: renovate-log.ndjson

.github/workflows/stage.yml

@@ -4,31 +4,15 @@ on: workflow_dispatch
 
 jobs:
   stage:
-    runs-on: ubuntu-latest
+    runs-on: antville
 
     environment:
       name: stage
-      url: https://antville-test.online
+      url: ${{ vars.stage_url }}
 
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up SSH agent
-        uses: ./.github/actions/ssh
-        with:
-          config: ${{ vars.SSH_CONFIG }}
-          key: ${{ secrets.SSH_PRIVATE_KEY }}
-          known-hosts: ${{ vars.SSH_KNOWN_HOSTS }}
-
-      - name: Set up Java
-        uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: 21
-
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
-
       - name: Build with Gradle
         run: ./gradlew installDist
 

.gitignore

@@ -1,22 +1,30 @@
-.gradle
-.idea
-.settings
-build
+# Generally ignore hidden files
+.*
 
-/apps
+# Manage some Codium configuration
+.vscode/*
+!.vscode
+!.vscode/extensions.json
+!.vscode/launch.json
+!.vscode/settings.json
+!.vscode/tasks.json
+
+# Ignore files created during build or run
 /bin
 /backups
-/db
+build
 /docs
-/extras
 /lib
 /licenses
 /log
+
+# Ignore files managed in src/dist
+/*.properties
+/apps
+/db
+/extras
+/launcher.jar
 /static
 
-/*.properties
-/launcher.jar
-/passwd
-/start.*
-
+# Manage Gradle configuration
 !/gradle.properties

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "java",
+      "name": "Current File",
+      "request": "launch",
+      "mainClass": "${file}"
+    },
+    {
+      "type": "java",
+      "name": "Debug",
+      "request": "launch",
+      "mainClass": "helma.main.Server",
+      "projectName": "helma_"
+    }
+  ]
+}

LICENSE.md

@@ -1,6 +1,6 @@
 # License
 
-Copyright (c) 1999-2008 Helma Project. All rights reserved.
+Copyright (c) 1999-2025 Helma Project. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

README.md

@@ -3,7 +3,7 @@
 ## TL;DR
 
 - Make sure you have Java 11 or higher installed
-- Download and unpack the [latest release](https://github.com/antville/helma/releases)
+- Download and unpack the [latest release](https://code.host.antville.org/antville/helma/releases)
 - Invoke `./bin/helma`, resp. `./bin/helma.bat`, depending on your platform
 - Direct your web browser to <http://localhost:8080>
 

build.gradle

@@ -1,6 +1,6 @@
 plugins {
   id 'application'
-  id 'com.github.jk1.dependency-license-report' version '2.7'
+  id 'com.github.jk1.dependency-license-report' version '2.9'
 }
 
 import org.apache.tools.ant.filters.FixCrLfFilter
@@ -42,15 +42,6 @@ if (JavaVersion.current().isJava8Compatible()) {
   }
 }
 
-sourceSets {
-  main {
-    java {
-      // Sources in `src` will be available here after processing
-      srcDirs = ["$buildDir/src/main/java"]
-    }
-  }
-}
-
 configurations {
   // Wrapping implementation because it does not allow access to its files
   // (i.e. cannot be resolved)
@@ -58,17 +49,17 @@ configurations {
 }
 
 dependencies {
-  implementation 'com.google.code.gson:gson:2.11.0'
-  implementation 'commons-codec:commons-codec:1.17.0'
+  implementation 'com.google.code.gson:gson:2.12.1'
+  implementation 'commons-codec:commons-codec:1.18.0'
   implementation 'commons-fileupload:commons-fileupload:1.5'
-  implementation 'commons-logging:commons-logging:1.3.2'
-  implementation 'commons-net:commons-net:3.10.0'
+  implementation 'commons-logging:commons-logging:1.3.5'
+  implementation 'commons-net:commons-net:3.11.1'
   implementation 'com.sun.mail:javax.mail:1.6.2'
   implementation 'javax.servlet:javax.servlet-api:4.0.1'
   implementation 'org.ccil.cowan.tagsoup:tagsoup:1.2.1'
-  implementation 'org.eclipse.jetty:jetty-servlet:9.4.54.v20240208'
-  implementation 'org.eclipse.jetty:jetty-xml:9.4.54.v20240208'
-  implementation 'org.mozilla:rhino:1.7.13'
+  implementation 'org.eclipse.jetty:jetty-servlet:9.4.57.v20241219'
+  implementation 'org.eclipse.jetty:jetty-xml:9.4.57.v20241219'
+  implementation 'org.mozilla:rhino-all:1.8.0'
   implementation 'org.sejda.imageio:webp-imageio:0.1.6'
   implementation 'xerces:xercesImpl:2.12.2'
   implementation 'xmlrpc:xmlrpc:2.0.1'
@@ -156,9 +147,11 @@ installDist {
   dependsOn build
 }
 
-tasks.register('processSource', Sync) {
+def processSource = tasks.register('processSource', Sync) {
   def gitOutput = new ByteArrayOutputStream()
 
+  outputs.dir "${project.buildDir}/src"
+
   exec {
     commandLine 'git', 'rev-parse', '--short', 'HEAD'
     standardOutput = gitOutput
@@ -172,9 +165,12 @@ tasks.register('processSource', Sync) {
     line -> line
       .replaceAll('__builddate__', new Date().format("d MMM yyyy"))
       .replaceAll('__commithash__', gitOutput.toString().trim())
-  } into "${project.buildDir}/src"
+      .replaceAll('__version__', version)
+  } into outputs.files.singleFile
 }
 
+tasks.compileJava.source = processSource.map { it.outputs.files }
+
 tasks.register('update') {
   dependsOn installDist
 

cliff.toml

@@ -0,0 +1,52 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+trim = true
+
+header = "## Changes"
+
+body = """
+{% for group, commits in commits | filter(attribute="merge_commit") | group_by(attribute="group") %}
+  ### {{ group | striptags | trim | upper_first }}
+  {% for commit in commits %}
+    * [<tt>{{ commit.id | split(pat="") | slice(end=11) | join() }}</tt>]\
+      (https://code.host.antville.org/antville/helma/commit/{{ commit.id }}) \
+      {% if commit.breaking %}**Breaking:** {% endif %}\
+      {{ commit.message | split(pat="\\n") | first | upper_first | escape }}\
+  {% endfor %}
+{% endfor %}
+
+**Full Changelog:** [{{ previous.version }} → {{ version }}]\
+(https://code.host.antville.org/antville/helma/compare/\
+{{ previous.version | urlencode }}..{{ version | urlencode }})\n\n
+"""
+
+footer = """
+Generated by [git-cliff](https://git-cliff.org/).
+"""
+
+[git]
+conventional_commits = false
+filter_commits = false
+filter_unconventional = false
+protect_breaking_commits = false
+sort_commits = "newest"
+split_commits = false
+topo_order = false
+
+commit_parsers = [
+  { message = "^Apply \\d+ suggestion", skip = true },
+  { message = "^Merge .*(branch|dependabot|dependency|renovate)", skip = true },
+  { message = "^Lock file maintenance", skip = true },
+  { message = "yarn\\.lock", skip = true },
+
+  { message = "^[Ff]ix", group = "<!-- 0 --> 🐛 Bug Fixes" },
+  { field = "author.name", pattern = "[Rr]enovate|[Dd]ependabot", group = "<!-- 3 --> 📦 Dependency Updates" },
+  { message = "^Merge pull request", group = "<!-- 1 --> 🔀 Merges" },
+  { message = ".*", group = "<!-- 2 --> Uncategorized" },
+]

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -84,7 +86,7 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum

gradlew.bat

@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################

modules/helma/build.gradle

@@ -1,8 +1,8 @@
 dependencies {
 	runtimeOnly 'ch.ethz.ganymed:ganymed-ssh2:build209'
 	runtimeOnly 'net.sourceforge.jexcelapi:jxl:2.5.7'
-	runtimeOnly 'org.apache.lucene:lucene-analyzers:3.6.2'
-	runtimeOnly 'org.apache.lucene:lucene-core:10.1.0'
+	runtimeOnly 'org.apache.lucene:lucene-analyzers:2.2.0'
+	runtimeOnly 'org.apache.lucene:lucene-core:2.2.0'
 }
 
 jar.enabled = false

settings.gradle

@@ -16,3 +16,6 @@ project(':modules').projectDir = file('modules/helma')
 project(':jala').projectDir = file('modules/jala')
 project(':hopKit').projectDir = file('modules/jala/util/HopKit')
 project(':test').projectDir = file('modules/jala/util/Test')
+
+// Rename this project to prevent redundancy and renaming of main project (VSC does not care, though)
+project(':modules').name = 'modules'

src/dist/extras/deploy.sh

@@ -0,0 +1,60 @@
+#!/bin/sh
+
+# Use this script as forced command of an authorized SSH key:
+# command="/home/helma/extras/deploy.sh" ssh-ed25519 AAAAC3NzaC…
+
+# Define HELMA_HOST and ANTVILLE_HOST in this file
+# shellcheck source=/dev/null
+. "$HOME"/deploy.env
+
+case "$SSH_ORIGINAL_COMMAND" in
+  ping)
+    echo pong
+    ;;
+
+  deploy-helma)
+    rsync ./ "$HELMA_HOST":./ \
+      --archive --compress --delete --verbose \
+      --filter '+ /bin' \
+      --filter '+ /extras' \
+      --filter '+ /launcher.jar' \
+      --filter '- /lib/ext' \
+      --filter '+ /lib' \
+      --filter '+ /modules' \
+      --filter '- /*'
+    printf 'Restarting Helma on HELMA_host… '
+    ssh "$HELMA_HOST" sudo /bin/systemctl restart helma
+    ;;
+
+  deploy-antville)
+    rsync ./apps/antville/ "$ANTVILLE_HOST":./apps/antville/ \
+      --archive --compress --delete --verbose \
+      --filter '+ /claustra' \
+      --filter '+ /code' \
+      --filter '+ /compat' \
+      --filter '+ /i18n' \
+      --filter '+ /lib' \
+      --filter '- /*'
+    rsync ./apps/antville/static/helma/ "$ANTVILLE_HOST":./apps/antville/static/helma/ \
+      --archive --compress --verbose \
+      --filter '+ /fonts' \
+      --filter '+ /formica.html' \
+      --filter '+ /img' \
+      --filter '+ /scripts' \
+      --filter '+ /styles' \
+      --filter '- /*'
+    printf 'Restarting Helma on ANTVILLE_host… '
+    ssh "$ANTVILLE_HOST" sudo /bin/systemctl restart helma
+    ;;
+
+  restart)
+    printf 'Restarting Helma… '
+    sudo /bin/systemctl restart helma
+    printf '%s\n' 'done.'
+    ;;
+
+  *)
+    # Allow any rsync command but restrict it to the installation directory
+    rrsync -wo /home/helma
+    ;;
+esac

src/dist/extras/helma.service

@@ -18,7 +18,7 @@ ExecStart = /usr/bin/java -server \
   -jar launcher.jar \
   -w 8080 -x 8081
 
-ExecReload = touch apps.properties && touch server.properties
+ExecReload = /bin/sh -c 'touch apps.properties && touch server.properties'
 ExecStop = /bin/kill -15 $MAINPID
 
 [Install]

src/main/java/helma/main/Server.java

@@ -36,7 +36,7 @@ import helma.util.ResourceProperties;
  */
 public class Server implements Runnable {
     // version string
-    public static final String version = "🐜";
+    public static final String version = "__version__";
 
     // build date
     public static final String buildDate = "__builddate__";
@@ -149,17 +149,13 @@ public class Server implements Runnable {
       * check if we are running on a Java 2 VM - otherwise exit with an error message
       */
     public static void checkJavaVersion() {
-        String javaVersion = System.getProperty("java.version");
+        String javaVersion = System.getProperty("java.version", "0");
+        int majorVersion = Integer.parseInt(javaVersion.split("\\.")[0]);
 
-        if ((javaVersion == null) || javaVersion.startsWith("1.5")
-                                  || javaVersion.startsWith("1.4")
-                                  || javaVersion.startsWith("1.3")
-                                  || javaVersion.startsWith("1.2")
-                                  || javaVersion.startsWith("1.1")
-                                  || javaVersion.startsWith("1.0")) {
-            System.err.println("This version of Helma requires Java 1.6 or greater.");
+        if (majorVersion < 11) {
+            System.err.println("This version of Helma requires Java 11 or greater.");
 
-            if (javaVersion == null) { // don't think this will ever happen, but you never know
+            if (majorVersion == 0) { // don't think this will ever happen, but you never know
                 System.err.println("Your Java Runtime did not provide a version number. Please update to a more recent version.");
             } else {
                 System.err.println("Your Java Runtime is version " + javaVersion +