New logchange.py script to simplify changelog handling in release wizard (#4413)

Refactor the wizard to generate CHANGELOG.md inside RC loop instead of before
Move cherry-picking of the changelog commits to main and stable branch until after the vote

Author: janhoy

.github/workflows/validate-changelog.yml

@@ -97,7 +97,7 @@ jobs:
           echo "Validating: $file"
 
           # Validate using a Python script
-          python3 .github/scripts/validate-changelog-yaml.py "$file"
+          python3 dev-tools/scripts/validate-changelog-yaml.py "$file"
 
           if [ $? -ne 0 ]; then
             VALIDATION_FAILED=true

dev-docs/changelog.adoc

@@ -113,7 +113,7 @@ The logchange gradle plugin offers some tasks, here are the two most important:
 
 The `logchangeRelease` and `logchangeGenerate` tasks are used by ReleaseWizard. The `logchangeArchive` task can be ran once for every major release or when the number of versioned changelog folders grow too large.
 
-These are integrated in the Release Wizard.
+These are integrated in the Release Wizard via `dev-tools/scripts/logchange.py`, which also handles RC2+ scenarios — see section 5.4.
 
 === 5.2 Migration tool
 
@@ -231,6 +231,12 @@ Example report output (Json or Markdown):
 }
 ----
 
+=== 5.4 Release candidate changelog script
+
+`dev-tools/scripts/logchange.py` handles changelog git operations for each RC
+and the final post-vote forward-porting.  It is integrated into the Release
+Wizard but can also be run standalone.  Run with `--help` for usage.
+
 == 6. Further Reading
 
 * https://github.com/logchange/logchange[Logchange web page]

dev-tools/scripts/README.md

@@ -182,6 +182,27 @@ Each YAML file complies with the schema outlined in `dev-docs/changelog.adoc`.
     # Default behavior
     python3 dev-tools/scripts/changes2logchange.py solr/CHANGES.txt
 
+### validate-changelog-yaml.py
+
+Validates one or more changelog YAML files, or all YAML files in a folder.
+Used by the GitHub Actions workflow to validate entries on pull requests,
+and called automatically by `logchange.py prepare` as a pre-flight check.
+
+    python3 dev-tools/scripts/validate-changelog-yaml.py changelog/unreleased/my-fix.yml
+    python3 dev-tools/scripts/validate-changelog-yaml.py changelog/unreleased/
+
+### logchange.py
+
+Handles changelog git operations during a release. Normally invoked by the
+Release Wizard, but can also be run standalone.
+
+    usage: logchange.py prepare [-h] --version VERSION --release-branch RELEASE_BRANCH [--gradle-cmd GRADLE_CMD]
+                            [--git-remote GIT_REMOTE] [--dry-run] [--commit]
+
+    usage: logchange.py forward-port [-h] --version VERSION --release-branch RELEASE_BRANCH [--gradle-cmd GRADLE_CMD]
+                                 [--git-remote GIT_REMOTE] [--dry-run] --stable-branch STABLE_BRANCH
+                                 [--release-date RELEASE_DATE] [--push]
+
 ### validateChangelogs.py
 
 Validates changelog folder structure and feature distribution across development branches (main, stable, release). See dev-docs for more.