changelog: move entry advise into template#4111
Open
dsmiley wants to merge 1 commit 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
| ** `deprecated` for deprecated features | ||
| ** `removed` for code removed in major releases | ||
| ** `dependency_update` for updates to dependencies | ||
| ** `security` for security-related changes |
Contributor
Author
There was a problem hiding this comment.
removed "security" as I think this is an orthogonal matter.
janhoy
reviewed
Feb 7, 2026
| # test infrastructure, or documentation. | ||
| # Most such changes are too small/minor to bother with a changelog entry. | ||
|
|
||
| # Reference issues as `SOLR-12345` or GitHub `PR#123`. |
Contributor
There was a problem hiding this comment.
Does this line belong under «title» instead?
Contributor
Author
There was a problem hiding this comment.
I don't know; you wrote it. I thought you meant this in relation to the linking section. But... I suppose not
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. |
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.