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/release.yml

@@ -9,16 +9,27 @@ permissions:
   contents: write
 
 jobs:
-  build:
+  release:
     runs-on: antville
 
     env:
-      GH_TOKEN: ${{ github.token }}
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
       LC_TIME: en_US.UTF-8
-      TODAY: $(date +'%d %b %Y')
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - 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
@@ -29,23 +40,20 @@ jobs:
           direction: upload
           url: https://code.host.antville.org
           token: ${{ github.token }}
-          title: ${{ env.TODAY }}
+          title: Helma ${{ github.ref_name }}
-          #tag: $(date +'%Y.%m.%d')
           release-dir: build/distributions
-          release-notes-assistant: true
+          release-notes: ${{ steps.create_release_notes.outputs.release_notes }}
           verbose: true
 
       - name: Create release at GitHub
-        # FIXME: Currently only outputs gh command; adapt for Forgejo
         run: |
-          echo gh release create "$GITHUB_REF_NAME" \
+          gh release create "$GITHUB_REF_NAME" \
             --repo "$GITHUB_REPOSITORY" \
-            --title "$(date +'%d %b %Y')" \
+            --title "Helma ${{ github.ref_name }}" \
-            --generate-notes
+            --notes "${{ steps.create_release_notes.outputs.release_notes }}"
 
       - name: Upload release assets to GitHub
-        # FIXME: Currently only outputs gh command; adapt for Forgejo
         run: |
-          echo gh release upload "$GITHUB_REF_NAME" \
+          gh release upload "$GITHUB_REF_NAME" build/distributions/helma-*.* \
-            build/distributions/helma-*.* \
+            --repo "$GITHUB_REPOSITORY" \
             --clobber

.gitignore

@@ -1,22 +1,30 @@
-.gradle
+# Generally ignore hidden files
-.idea
+.*
-.settings
-build
 
-/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
+# Manage Gradle configuration
-/launcher.jar
-/passwd
-/start.*
-
 !/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

@@ -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,16 +49,16 @@ configurations {
 }
 
 dependencies {
-  implementation 'com.google.code.gson:gson:2.11.0'
+  implementation 'com.google.code.gson:gson:2.12.1'
-  implementation 'commons-codec:commons-codec:1.17.1'
+  implementation 'commons-codec:commons-codec:1.18.0'
   implementation 'commons-fileupload:commons-fileupload:1.5'
-  implementation 'commons-logging:commons-logging:1.3.4'
+  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.56.v20240826'
+  implementation 'org.eclipse.jetty:jetty-servlet:9.4.57.v20241219'
-  implementation 'org.eclipse.jetty:jetty-xml:9.4.56.v20240826'
+  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'
@@ -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
@@ -173,9 +166,11 @@ tasks.register('processSource', Sync) {
       .replaceAll('__builddate__', new Date().format("d MMM yyyy"))
       .replaceAll('__commithash__', gitOutput.toString().trim())
       .replaceAll('__version__', version)
-  } into "${project.buildDir}/src"
+  } 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.12-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

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