You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "ASF subversion and git services (Jira)" <ji...@apache.org> on 2026/07/28 23:51:00 UTC
[jira] [Commented] (SOLR-17619) Generate CHANGELOG.md (formerly CHANGES.txt) via logchange
[ https://issues.apache.org/jira/browse/SOLR-17619?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18099884#comment-18099884 ]
ASF subversion and git services commented on SOLR-17619:
--------------------------------------------------------
Commit 0264a45a39da5e9576b34c3d8f263686555f6a0d in solr's branch refs/heads/main from Christine Poerschke
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=0264a45a39d ]
SOLR-17619: small dev-docs/changelog.adoc tweaks (#3805)
Co-authored-by: Jan Høydahl <ja...@apache.org>
> Generate CHANGELOG.md (formerly CHANGES.txt) via logchange
> ----------------------------------------------------------
>
> Key: SOLR-17619
> URL: https://issues.apache.org/jira/browse/SOLR-17619
> Project: Solr
> Issue Type: Task
> Components: Build
> Reporter: David Smiley
> Assignee: Jan Høydahl
> Priority: Major
> Labels: pull-request-available
> Fix For: 9.10
>
> Time Spent: 11h 20m
> Remaining Estimate: 0h
>
> The [logchange|https://github.com/logchange/logchange] tool helps projects maintain a log of changes. Each change (e.g. from a PR) will no longer edit a CHANGES.txt file; instead it will include a _new_ YAML file in an appropriate directory with others for the next Solr version. The release process will execute the tool, which will build a CHANGELOG.md file and will probably also do something with the YAML files (remove?).
> Decide the most convenient way for us to run the tool for change authors. Could a gradle task do it? See [this issue|https://github.com/logchange/logchange/issues/397] filed on the logchange project.
> Outcome of this issue:
> * a logchange tool configuration file -- logchange-config.yml
> * Solr 10's CHANGES.txt entries converted to YAML. (start this issue by doing only a few before over-investing)
> * a dev-docs page
> ** for contributors/everyone: basic info explaining how each new change should be recorded. Explain how to run the tool to generate the YAML file. What field(s) matter the most; what should be ignored. Link to further details.
> ** for release manager: how to produce CHANGELOG.md. Link to further details. Ultimately this will probably move to the release wizard in some fashion.
> TBD: CHANGES.txt < 10 and CHANGELOG.md > 10 ?
> TBD: changes.html generation in the release process will be removed or will change.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org