apache / apache/lucene

More structured management of CHANGES.txt

Open
#15,421 10 comments 0 reactions 0 assignees View on GitHub
type:task
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

### Description

There's been interesting patch in Solr that aims at making CHANGES.txt management better [1]. This file gets out of sync between branches all the time and is notoriously difficult to get right.

I'm not advocating to take the same approach as Solr did but it'd be nice to somehow:

* make it easier to verify that PRs put the changes entry in the right place (attach them to the right version),
* make the active-versions CHANGES.txt smaller and easier to view/convert to other formats.

Another alternative that I know of is to generate these from git logs but this requires some attention when formatting commit messages and may be hard to enforce.

[1] https://issues.apache.org/jira/browse/SOLR-17619

Contributor guide

Open the contributing guide

Research direction

Review CHANGES.txt and the linked Solr issue first to understand the proposed approaches. Compare how entries are organized across active versions and how git logs might supply them. Done should include a decided workflow that verifies entry placement and makes active-version changes easier to view or convert.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.