changelog: move entry advise into template#4111
Open
dsmiley wants to merge 4 commits intoapache:mainfrom
Open
Conversation
Move entry advise from the adoc into the entry template. Improve / clarify the advise. Drop `security` type, which is orthogonal.
github-actions
bot
added
documentation
dsmiley
commented
Feb 7, 2026
janhoy
reviewed
Feb 7, 2026
Contributor
|
Come to think of, on main branch we have a script https://github.com/apache/solr/blob/main/.github/scripts/validate-changelog-yaml.py used by GitHub to validate changelog. This script should now probably also validate that the wall of comments are actually removed. |
# Conflicts: # gradle/changelog.gradle
Contributor
Author
|
I'd like to merge this Friday, if not sooner with an approving review. |
janhoy
approved these changes
Feb 19, 2026
Contributor
janhoy
left a comment
janhoy
left a comment
There was a problem hiding this comment.
Added a validation step. Rest looks good to me
| # Validate that comments are removed | ||
| for not_allowed in not_allowed_text: | ||
| if not_allowed in raw_content: | ||
| print(f"::error file={file_path}::File still contains commented template text. Please remove the comment block at the top of the file.") |
Contributor
There was a problem hiding this comment.
I added this check to the changelog checker so we get warning in PR if comments are not removed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move entry advise from the adoc into the entry template. Improve / clarify the advise.
Drop
securitytype, which is orthogonal.