You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "dsmiley (via GitHub)" <gi...@apache.org> on 2026/02/06 19:22:18 UTC
[PR] changelog: move entry advise into template [solr]
dsmiley opened a new pull request, #4111:
URL: https://github.com/apache/solr/pull/4111
Move entry advise from the adoc into the entry template. Improve / clarify the advise.
Drop `security` type, which is orthogonal.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "janhoy (via GitHub)" <gi...@apache.org>.
janhoy commented on code in PR #4111:
URL: https://github.com/apache/solr/pull/4111#discussion_r2830396673
##########
.github/scripts/validate-changelog-yaml.py:
##########
@@ -120,6 +123,12 @@ def validate_changelog_yaml(file_path):
print(f"::error file={file_path}::Field 'issues' value {data['issues']} points to a non-existing github PR. Did you intend to reference a JIRA issue, please use 'links'.")
return False
+ # 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.")
Review Comment:
I added this check to the changelog checker so we get warning in PR if comments are not removed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley commented on PR #4111:
URL: https://github.com/apache/solr/pull/4111#issuecomment-3924604577
I'd like to merge this Friday, if not sooner with an approving review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "janhoy (via GitHub)" <gi...@apache.org>.
janhoy commented on PR #4111:
URL: https://github.com/apache/solr/pull/4111#issuecomment-3864557526
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.
Also, the e could instruct LLM in AGENTS.md to use the script for validation after adding a changelog.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley commented on code in PR #4111:
URL: https://github.com/apache/solr/pull/4111#discussion_r2777611693
##########
gradle/changelog.gradle:
##########
@@ -44,25 +44,45 @@ task writeChangelog {
def jiraRef = jiraMatcher ? jiraMatcher[0].toUpperCase() : "SOLR-XXXX"
def jiraUrl = "https://issues.apache.org/jira/browse/${jiraRef}"
def jiraLinks = jiraMatcher ? "links:\n - name: ${jiraRef}\n url: ${jiraUrl}" : ""
- def title = gitBranch.replaceFirst(/(?i)SOLR-\d\d\d+\b-?/, "").replace("-", " ").capitalize()
- // Warn user when generating empty title
- if (title.isEmpty()) {
- println "WARNING: Title in generated changelog is empty, please edit"
- }
+ def title = gitBranch.replaceFirst(/(?i)SOLR-\d\d\d+-/, "").replace("-", " ").capitalize()
// Strip everything before and including '/', then sanitize special characters
def sanitizedBranchName = gitBranch.replaceAll(/^.*\//, "").replaceAll(/[^a-zA-Z0-9._-]/, "-")
def fileName = "changelog/unreleased/${sanitizedBranchName}.yml"
def file = new File(fileName)
file.parentFile.mkdirs()
- file.text = """# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+ file.text = """# (DELETE ALL COMMENTS UP HERE AFTER FILLING THIS IN
+
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+
+# If the change is minor (typos, small improvements), don't bother adding an entry.
+
+# title:
+# * The audience is end-users and administrators, not committers.
+# * Be short and focused on the user impact, nevertheless multiple sentences is fine!
+# * For technical/geeky details, prefer the commit message instead of changelog
+
+# type:
+# `added` for new features/improvements, opt-in by the user typically documented in the ref guide
+# `changed` for improvements; not opt-in
+# `fixed` for improvements that are deemed to have fixed buggy behavior
+# `deprecated` for marking things deprecated
+# `removed` for code removed
+# `dependency_update` for updates to dependencies
+# `other` for anything else, like large/significant refactorings, build changes,
+# 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`.
Review Comment:
I don't know; you wrote it. I *thought* you meant this in relation to the linking section. But... I suppose not
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley merged PR #4111:
URL: https://github.com/apache/solr/pull/4111
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "janhoy (via GitHub)" <gi...@apache.org>.
janhoy commented on code in PR #4111:
URL: https://github.com/apache/solr/pull/4111#discussion_r2777583187
##########
gradle/changelog.gradle:
##########
@@ -44,25 +44,45 @@ task writeChangelog {
def jiraRef = jiraMatcher ? jiraMatcher[0].toUpperCase() : "SOLR-XXXX"
def jiraUrl = "https://issues.apache.org/jira/browse/${jiraRef}"
def jiraLinks = jiraMatcher ? "links:\n - name: ${jiraRef}\n url: ${jiraUrl}" : ""
- def title = gitBranch.replaceFirst(/(?i)SOLR-\d\d\d+\b-?/, "").replace("-", " ").capitalize()
- // Warn user when generating empty title
- if (title.isEmpty()) {
- println "WARNING: Title in generated changelog is empty, please edit"
- }
+ def title = gitBranch.replaceFirst(/(?i)SOLR-\d\d\d+-/, "").replace("-", " ").capitalize()
// Strip everything before and including '/', then sanitize special characters
def sanitizedBranchName = gitBranch.replaceAll(/^.*\//, "").replaceAll(/[^a-zA-Z0-9._-]/, "-")
def fileName = "changelog/unreleased/${sanitizedBranchName}.yml"
def file = new File(fileName)
file.parentFile.mkdirs()
- file.text = """# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+ file.text = """# (DELETE ALL COMMENTS UP HERE AFTER FILLING THIS IN
+
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+
+# If the change is minor (typos, small improvements), don't bother adding an entry.
+
+# title:
+# * The audience is end-users and administrators, not committers.
+# * Be short and focused on the user impact, nevertheless multiple sentences is fine!
+# * For technical/geeky details, prefer the commit message instead of changelog
+
+# type:
+# `added` for new features/improvements, opt-in by the user typically documented in the ref guide
+# `changed` for improvements; not opt-in
+# `fixed` for improvements that are deemed to have fixed buggy behavior
+# `deprecated` for marking things deprecated
+# `removed` for code removed
+# `dependency_update` for updates to dependencies
+# `other` for anything else, like large/significant refactorings, build changes,
+# 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`.
Review Comment:
Does this line belong under «title» instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] changelog: move entry advise into template [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley commented on code in PR #4111:
URL: https://github.com/apache/solr/pull/4111#discussion_r2776950162
##########
dev-docs/changelog.adoc:
##########
@@ -78,25 +78,11 @@ user.githubid=johngithub
user.asfid=johnapache
----
-TIP: Aliases for `writeChangelog` task are `changelog` and `newChangelog`.
-
-== 4. Writing Good Entries
-
-* **Audience** is end-users and administrators, not committers.
-* If the change is super minor, like a typo, don't bother adding a yaml file
-* Keep the entry short and focused on the user impact.
-* Choose the correct *type*:
-** `added` for new features
-** `changed` for improvements to existing code
-** `fixed` for bug fixes
-** `deprecated` for deprecated features
-** `removed` for code removed in major releases
-** `dependency_update` for updates to dependencies
-** `security` for security-related changes
Review Comment:
removed "security" as I think this is an orthogonal matter.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org