Skip to content

Conversation

@janhoy
Copy link
Contributor

@janhoy janhoy commented Oct 24, 2025

https://issues.apache.org/jira/browse/SOLR-17979

Some new tools and improvements to wizard and existing tooling for RM

@janhoy janhoy requested a review from Copilot October 24, 2025 18:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces validateChangelogs.py, a validation tool that helps release managers ensure changelog folder structure consistency across the four active Solr development branches (main, stable, release, and previous major branches). The tool validates that versioned changelog folders are identical across branches, prevents released files from appearing in unreleased folders, analyzes feature distribution, and optionally checks for duplicate JIRA issues. Additionally, it can generate a consolidated CHANGELOG.md preview similar to the legacy CHANGES.txt format.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

File Description
dev-tools/scripts/validateChangelogs.py New validation tool with full implementation for changelog structure validation, branch discovery, duplicate detection, and report generation
dev-tools/scripts/releaseWizard.yaml Added changelog validation step and relocated cherry-pick task to occur before validation
dev-tools/scripts/changes2logchange.py Modified slug generation to use spaces instead of dashes and improved filename sanitization
dev-tools/scripts/README.md Added documentation for the new validateChangelogs.py tool

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 24, 2025
@janhoy janhoy marked this pull request as draft October 28, 2025 09:10
@janhoy
Copy link
Contributor Author

janhoy commented Oct 28, 2025

I'll test this tool in the upcoming 9.10 release, tweak as needed and merge after the release.

@janhoy janhoy changed the base branch from main to branch_9_10 October 31, 2025 22:19
@janhoy janhoy force-pushed the tools-for-changelog-validation branch 2 times, most recently from 78039a7 to dd8d70a Compare November 1, 2025 23:29
@janhoy janhoy changed the title SOLR-17619 Add validateChangelogs.py tool for changelog validation across branches SOLR-17619 Imrpove release tooling during 9.10 release Nov 1, 2025
@janhoy janhoy changed the title SOLR-17619 Imrpove release tooling during 9.10 release SOLR-17979 Imrpove release tooling during 9.10 release Nov 1, 2025
@janhoy janhoy force-pushed the tools-for-changelog-validation branch from 5249d1c to 607a121 Compare November 2, 2025 15:08
@janhoy janhoy marked this pull request as ready for review November 2, 2025 15:08
- Port tool parseContributorsFromChanges.py to use logchange
- Release Wizard improvements for 9.10.0:
  - support for persisting vars in commands
  - changed logchange steps
- Many improvements in the 1-time changes2logchange.py utility
- Bug fix changes2html.py to handle ALPHA/BETA releases
- New validateChangelogs.py tool
@janhoy janhoy force-pushed the tools-for-changelog-validation branch from 607a121 to 6016746 Compare November 2, 2025 15:12
@janhoy janhoy merged commit 6fe796b into apache:branch_9_10 Nov 2, 2025
1 of 3 checks passed
@janhoy janhoy deleted the tools-for-changelog-validation branch November 2, 2025 15:12
janhoy added a commit to janhoy/solr that referenced this pull request Nov 2, 2025
- Port tool parseContributorsFromChanges.py to use logchange
- Release Wizard improvements for 9.10.0:
  - support for persisting vars in commands
  - changed logchange steps
- Many improvements in the 1-time changes2logchange.py utility
- Bug fix changes2html.py to handle ALPHA/BETA releases
- New validateChangelogs.py tool
@janhoy janhoy changed the title SOLR-17979 Imrpove release tooling during 9.10 release SOLR-17979 Improve release tooling during 9.10 release Nov 2, 2025
janhoy added a commit that referenced this pull request Nov 2, 2025
- Port tool parseContributorsFromChanges.py to use logchange
- Release Wizard improvements for 9.10.0:
  - support for persisting vars in commands
  - changed logchange steps
- Many improvements in the 1-time changes2logchange.py utility
- Bug fix changes2html.py to handle ALPHA/BETA releases
- New validateChangelogs.py tool
janhoy added a commit that referenced this pull request Nov 2, 2025
- Port tool parseContributorsFromChanges.py to use logchange
- Release Wizard improvements for 9.10.0:
  - support for persisting vars in commands
  - changed logchange steps
- Many improvements in the 1-time changes2logchange.py utility
- Bug fix changes2html.py to handle ALPHA/BETA releases
- New validateChangelogs.py tool
janhoy added a commit to janhoy/solr that referenced this pull request Nov 2, 2025
- Port tool parseContributorsFromChanges.py to use logchange
- Release Wizard improvements for 9.10.0:
  - support for persisting vars in commands
  - changed logchange steps
- Many improvements in the 1-time changes2logchange.py utility
- Bug fix changes2html.py to handle ALPHA/BETA releases
- New validateChangelogs.py tool
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation scripts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant