SOLR-17619 Use logchange for changelog management

.editorconfig

@@ -671,6 +671,9 @@ ij_yaml_space_before_colon = false
 ij_yaml_spaces_within_braces = true
 ij_yaml_spaces_within_brackets = true
 
+[dev-tools/scripts/releaseWizard.yaml]
+trim_trailing_whitespace = false
+
 # dos files
 [{*.bat,*.cmd}]
 end_of_line = crlf

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,7 +7,7 @@ Before creating a pull request, please file an issue in the ASF Jira system for
 
 * https://issues.apache.org/jira/projects/SOLR
 
-For something minor (i.e. that wouldn't be worth putting in release notes), you can skip JIRA. 
+For something minor (i.e. that wouldn't be worth putting in release notes), you can skip JIRA.
 To create a Jira issue, you will need to create an account there first.
 
 The title of the PR should reference the Jira issue number in the form:
@@ -42,3 +42,4 @@ Please review the following and check all that apply:
 - [ ] I have run `./gradlew check`.
 - [ ] I have added tests for my changes.
 - [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
+- [ ] I have added a [changelog entry](https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc) for my change

.github/scripts/validate-changelog-yaml.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""
+Validates changelog YAML files in changelog/unreleased/ folder.
+
+Checks:
+- File is valid YAML
+- Contains required 'title' field (non-empty string)
+- Contains required 'type' field (one of: added, changed, fixed, deprecated, removed, dependency_update, security, other)
+- Contains required 'authors' field with at least one author
+- Each author has a 'name' field (non-empty string)
+"""
+
+import sys
+import yaml
+
+
+def validate_changelog_yaml(file_path):
+    """Validate a changelog YAML file."""
+    valid_types = ['added', 'changed', 'fixed', 'deprecated', 'removed', 'dependency_update', 'security', 'other']
+
+    try:
+        with open(file_path, 'r', encoding='utf-8') as f:
+            data = yaml.safe_load(f)
+
+        # Check if file contains a mapping (dictionary)
+        if not isinstance(data, dict):
+            print(f"::error file={file_path}::File must contain YAML mapping (key-value pairs)")
+            return False
+
+        # Validate 'title' field
+        if 'title' not in data or not data['title']:
+            print(f"::error file={file_path}::Missing or empty 'title' field")
+            return False
+
+        if not isinstance(data['title'], str) or not data['title'].strip():
+            print(f"::error file={file_path}::Field 'title' must be a non-empty string")
+            return False
+
+        # Validate 'type' field
+        if 'type' not in data or not data['type']:
+            print(f"::error file={file_path}::Missing or empty 'type' field")
+            return False
+
+        if data['type'] not in valid_types:
+            print(f"::error file={file_path}::Invalid 'type': '{data['type']}'. Must be one of: {', '.join(valid_types)}")
+            return False
+
+        # Validate 'authors' field
+        if 'authors' not in data or not data['authors']:
+            print(f"::error file={file_path}::Missing or empty 'authors' field")
+            return False
+
+        if not isinstance(data['authors'], list):
+            print(f"::error file={file_path}::Field 'authors' must be a list")
+            return False
+
+        if len(data['authors']) == 0:
+            print(f"::error file={file_path}::Field 'authors' must contain at least one author")
+            return False
+
+        # Validate each author
+        for i, author in enumerate(data['authors']):
+            if not isinstance(author, dict):
+                print(f"::error file={file_path}::Author {i} must be a mapping (key-value pairs)")
+                return False
+            if 'name' not in author or not author['name']:
+                print(f"::error file={file_path}::Author {i} missing or empty 'name' field")
+                return False
+            if not isinstance(author['name'], str) or not author['name'].strip():
+                print(f"::error file={file_path}::Author {i} 'name' must be a non-empty string")
+                return False
+
+        # All validations passed
+        print(f"✓ {file_path} is valid")
+        print(f"  Title: {data['title']}")
+        print(f"  Type: {data['type']}")
+        print(f"  Authors: {', '.join(a['name'] for a in data['authors'])}")
+        return True
+
+    except yaml.YAMLError as e:
+        print(f"::error file={file_path}::Invalid YAML: {e}")
+        return False
+    except Exception as e:
+        print(f"::error file={file_path}::Error validating file: {e}")
+        return False
+
+
+if __name__ == '__main__':
+    if len(sys.argv) < 2:
+        print("Usage: validate-changelog-yaml.py <yaml-file>")
+        sys.exit(1)
+
+    file_path = sys.argv[1]
+    if not validate_changelog_yaml(file_path):
+        sys.exit(1)

.github/workflows/validate-changelog.yml

@@ -0,0 +1,127 @@
+name: Validate Changelog
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  validate-changelog:
+    name: Check changelog entry
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+      with:
+        fetch-depth: 0
+
+    - name: Check for no-changelog label
+      id: check-label
+      run: |
+        LABELS='${{ toJson(github.event.pull_request.labels) }}'
+        if echo "$LABELS" | grep -q '"no-changelog"'; then
+          echo "skip=true" >> $GITHUB_OUTPUT
+        else
+          echo "skip=false" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Check for CHANGES.txt edits
+      if: steps.check-label.outputs.skip == 'false'
+      run: |
+        # Get the list of changed files
+        CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD)
+
+        if echo "$CHANGED_FILES" | grep -q "^solr/CHANGES\.txt$"; then
+          echo "::error::Use of solr/CHANGES.txt is deprecated. Please create a changelog yaml file instead."
+          echo ""
+          echo "Instead of editing CHANGES.txt, please:"
+          echo "1. Run: ./gradlew writeChangelog"
+          echo "2. Edit the generated YAML file in changelog/unreleased/"
+          echo "3. Commit both the code change and the YAML file"
+          echo ""
+          echo "For more information, see: dev-docs/changelog.adoc"
+          echo ""
+          echo "If this PR should not have a changelog entry (e.g., documentation-only changes),"
+          echo "add the 'no-changelog' label to this PR."
+          exit 1
+        fi
+
+    - name: Check for changelog entry
+      if: steps.check-label.outputs.skip == 'false'
+      run: |
+        # Get the list of changed files
+        CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD)
+
+        # Check if any files were added to changelog/unreleased/
+        if echo "$CHANGED_FILES" | grep -q "^changelog/unreleased/"; then
+          echo "✓ Changelog entry found"
+          exit 0
+        fi
+
+        # Check if only docs/tests/comments were changed (common exceptions)
+        HAS_NON_DOCS_CHANGES=false
+        while IFS= read -r file; do
+          # Skip changelog, docs, tests, and certain config files
+          if ! echo "$file" | grep -qE "(^changelog/|^solr/solr-ref-guide/|^dev-docs/|\.md$|\.adoc$|^solr/.*/test|\.gradle$|\.properties$|README|NOTICE|LICENSE)"; then
+            HAS_NON_DOCS_CHANGES=true
+            break
+          fi
+        done <<< "$CHANGED_FILES"
+
+        if [ "$HAS_NON_DOCS_CHANGES" = false ]; then
+          echo "✓ No code changes detected (docs/tests only)"
+          exit 0
+        fi
+
+        echo "::error::This PR appears to contain code changes but no changelog entry was added."
+        echo ""
+        echo "Please add a changelog entry by:"
+        echo "1. Running: ./gradlew writeChangelog"
+        echo "2. Editing the generated YAML file in changelog/unreleased/"
+        echo "3. Committing the YAML file"
+        echo ""
+        echo "For more information, see: dev-docs/changelog.adoc"
+        echo ""
+        echo "If this PR should not have a changelog entry (e.g., refactoring, internal cleanup),"
+        echo "add the 'no-changelog' label to this PR."
+        exit 1
+
+    - name: Validate changelog YAML structure
+      if: steps.check-label.outputs.skip == 'false'
+      run: |
+        # Get the list of changed files
+        CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD)
+
+        # Find all YAML files added to changelog/unreleased/
+        YAML_FILES=$(echo "$CHANGED_FILES" | grep "^changelog/unreleased/.*\.ya\?ml$" || true)
+
+        if [ -z "$YAML_FILES" ]; then
+          exit 0
+        fi
+
+        echo "Validating changelog YAML files..."
+        VALIDATION_FAILED=false
+
+        while IFS= read -r file; do
+          if [ -z "$file" ]; then
+            continue
+          fi
+
+          echo ""
+          echo "Validating: $file"
+
+          # Validate using a Python script
+          python3 .github/scripts/validate-changelog-yaml.py "$file"
+
+          if [ $? -ne 0 ]; then
+            VALIDATION_FAILED=true
+          fi
+
+        done <<< "$YAML_FILES"
+
+        if [ "$VALIDATION_FAILED" = true ]; then
+          echo "Please see dev-docs/changelog.adoc for more info."
+
+          exit 1
+        fi

.gitignore

@@ -41,4 +41,4 @@ gradle/wrapper/gradle-wrapper.jar
 
 # WANT TO ADD MORE?  You can tell Git without adding to this file:
 # See https://git-scm.com/docs/gitignore
-# In particular, if you have tools you use, add to $GIT_DIR/info/exclude or use core.excludesFile
+# In particular, if you have tools you use, add to $GIT_DIR/info/exclude or use core.excludesFile

CHANGELOG.md

@@ -0,0 +1,26 @@
+<!-- @formatter:off -->
+<!-- noinspection -->
+<!-- Prevents auto format, for JetBrains IDE File > Settings > Editor > Code Style (Formatter Tab) > Turn formatter on/off with markers in code comments  -->
+
+<!-- This file is automatically generate by logchange tool 🌳 🪓 => 🪵 -->
+<!-- Visit https://github.com/logchange/logchange and leave a star 🌟 -->
+<!-- !!! ⚠️ DO NOT MODIFY THIS FILE, YOUR CHANGES WILL BE LOST ⚠️ !!! -->
+
+
+DUMMY changelog file.
+
+We are in the process of migrating from CHANGES.txt to a structured approach to changelog generation. See [SOLR-17619](https://issues.apache.org/jira/browse/SOLR-17619) as well as [dev-docs/changelog.adoc](dev-docs/changelog.adoc) for details.
+
+[unreleased]
+------------
+
+### Added (1 change)
+
+- Dummy issue [SOLR-123](https://issues.apache.org/jira/browse/SOLR-123) (janhoy)
+
+[9.9.0] - 2025-07-24
+--------------------
+
+### Added (1 change)
+
+- Dummy issue for release 9.9 [SOLR-124](https://issues.apache.org/jira/browse/SOLR-124) (janhoy)

build.gradle

@@ -33,6 +33,7 @@ plugins {
   alias(libs.plugins.diffplug.spotless) apply false
   alias(libs.plugins.nodegradle.node) apply false
   alias(libs.plugins.openapi.generator) apply false
+  alias(libs.plugins.logchange)
 }
 
 // Declare default Java versions for the entire project and for SolrJ separately
@@ -216,3 +217,5 @@ apply from: file('gradle/solr/packaging.gradle')
 apply from: file('gradle/solr/solr-forbidden-apis.gradle')
 
 apply from: file('gradle/node.gradle')
+
+apply from: file('gradle/changelog.gradle')

changelog/README.md

@@ -0,0 +1,21 @@
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+ -->
+# New changelog process
+
+We are in the process of migrating to a new way of managing our changelog. Please see [dev-docs/changelog.adoc](../dev-docs/changelog.adoc) for details.
+
+In a transition period it is still possible to merge your changelog entry to `solr/CHANGES.txt`, but then you can only use the new process.