You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@solr.apache.org by David Smiley <ds...@apache.org> on 2024/05/16 18:51:54 UTC
CHANGES.txt, process improvement solicitation
Managing CHANGES.txt in each PR/change we do is a pain. It's so
merge-conflict prone. I don't mean to call for the removal of
CHANGES.txt (although I've wished for this off-and-on), but want to
solicit inputs on what can be done to make this easier.
I could be mistaken but maybe it was Calvin Cowie that recommended a
scheme something like the following: each change/PR merely adds its
own txt file to a new CHANGES directory instead of adding to
CHANGES.txt. Then it will be aggregated / concatenated to CHANGES.txt
at a release boundary by the RM using a script. The per-change file
then goes away. The category (e.g. New Feature vs Bug Fix) would need
to be encoded somewhere, like maybe in the file name. Even the JIRA
number could be part of the file name and not its content. No ad-hoc
newline use either; just write the message and the script will
line-wrap it. This is probably the simplest and least disruptive
change.
I'm kind of envious of small projects that can simply rely on GitHub's
release notes generator [1]. Yeah it's just the first-line commit
message, which emphasizes brevity over clarity.
[1] https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
~ David Smiley
Apache Lucene/Solr Search Developer
http://www.linkedin.com/in/davidwsmiley
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
For additional commands, e-mail: dev-help@solr.apache.org
Re: CHANGES.txt, process improvement solicitation
Posted by Christos Malliaridis <ma...@apache.org>.
The changes.txt file confuses me a lot and I would love to see some improvements there. It is not clear to me at the moment of the PR creation / merge which version will be next to add the change entry to. Using a tool like the one Jan proposed makes sense to me and would likely solve the issues I see.
Alessandro, you mentioned error-prone as an issue, I believe you are talking about google error-prone. I wanted to enable more rules step by step to avoid potential issues (see for example https://github.com/apache/solr/pull/2881). I was not aware that this may be an issue. Could you please elaborate on this?
Allow me to add the dependency resolution process as another issue, that I have made worse in the main branch. I still believe in the switch to the gradle version catalogs, but I think it should be easier and more straight-forward to resolve dependency conflicts. I am still working on that topic and have already a few improvements in a draft that I would like to add once there is a working version (see https://github.com/apache/solr/pull/2915). If you have any input on that please share it.
Best,
Christos
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
For additional commands, e-mail: dev-help@solr.apache.org
Re: CHANGES.txt, process improvement solicitation
Posted by Jan Høydahl <ja...@cominvent.com>.
Hi,
A gradle plugin would be nice but probably we can work around it by either
providing a template for contributors to copy, or somehow use the CLI tool <https://github.com/logchange/logchange?tab=readme-ov-file#logchange-cli>.
I should mention here as well that I some time ago also filed an issue to the
logchange project (https://github.com/logchange/logchange/issues/370) explaining
Solr's branching and release process. The developer has replied, trying to
accomodate all our requirements, but I have not yet had a chance to reply
to his comments after the holidays. Will do so now.
It is promising to see that the tool meets most of our needs and the developer
is willing to bridge the gap. It could of course be that we can also change some of
our habits too :)
Jan
> 13. jan. 2025 kl. 01:47 skrev David Smiley <ds...@apache.org>:
>
> I followed up with a JIRA issue
> https://issues.apache.org/jira/browse/SOLR-17619 and also filed an issue on
> the logchange project to support Gradle:
> https://github.com/logchange/logchange/issues/397 at least for adding new
> change entries conveniently. That might be considered a blocker as we
> need/want creating new entries to be super easy.
>
> On Fri, Dec 20, 2024 at 4:43 AM Jan Høydahl <ja...@cominvent.com> wrote:
>
>> Good news, a new release is on its way, including a CLI tool <
>> https://github.com/logchange/logchange/pull/31> independent from maven.
>> This means we could integrate it into our process with simple commands like
>> ./logchange release --version 9.8.0
>> ... which will move yml files from folder "unreleased" into folder "v9.8.0"
>> and then generate CHANGELOG.md with ./logchange generate.
>>
>> See https://github.com/logchange/logchange/tree/main/changelog for how the
>> strucuture looks like.
>>
>> Jan
>>
>>> 19. des. 2024 kl. 20:34 skrev David Smiley <ds...@apache.org>:
>>>
>>> On Wed, Dec 18, 2024 at 7:30 PM Jan Høydahl <ja...@cominvent.com>
>> wrote:
>>>
>>>> This tool does what is proposed here and looks promising:
>>>> https://github.com/logchange/logchange?tab=readme-ov-file
>>>>
>>>> It requires us to switch to CHANGES.md and it lacks a gradle plugin. But
>>>> we could probably contribute some changes to fit our needs..
>>>>
>>>
>>> We don't require a gradle plugin. Arguably it should have been done as
>>> simple scripts without being tied to any build system. There's even a
>> TODO
>>> on its main page that refers to a Docker version. I could imagine one of
>>> us essentially doing this (creating the Dockerfile and any scripts) so
>> that
>>> it can more easily be run; maybe tailored for us.
>>
>>
Re: CHANGES.txt, process improvement solicitation
Posted by David Smiley <ds...@apache.org>.
I followed up with a JIRA issue
https://issues.apache.org/jira/browse/SOLR-17619 and also filed an issue on
the logchange project to support Gradle:
https://github.com/logchange/logchange/issues/397 at least for adding new
change entries conveniently. That might be considered a blocker as we
need/want creating new entries to be super easy.
On Fri, Dec 20, 2024 at 4:43 AM Jan Høydahl <ja...@cominvent.com> wrote:
> Good news, a new release is on its way, including a CLI tool <
> https://github.com/logchange/logchange/pull/31> independent from maven.
> This means we could integrate it into our process with simple commands like
> ./logchange release --version 9.8.0
> ... which will move yml files from folder "unreleased" into folder "v9.8.0"
> and then generate CHANGELOG.md with ./logchange generate.
>
> See https://github.com/logchange/logchange/tree/main/changelog for how the
> strucuture looks like.
>
> Jan
>
> > 19. des. 2024 kl. 20:34 skrev David Smiley <ds...@apache.org>:
> >
> > On Wed, Dec 18, 2024 at 7:30 PM Jan Høydahl <ja...@cominvent.com>
> wrote:
> >
> >> This tool does what is proposed here and looks promising:
> >> https://github.com/logchange/logchange?tab=readme-ov-file
> >>
> >> It requires us to switch to CHANGES.md and it lacks a gradle plugin. But
> >> we could probably contribute some changes to fit our needs..
> >>
> >
> > We don't require a gradle plugin. Arguably it should have been done as
> > simple scripts without being tied to any build system. There's even a
> TODO
> > on its main page that refers to a Docker version. I could imagine one of
> > us essentially doing this (creating the Dockerfile and any scripts) so
> that
> > it can more easily be run; maybe tailored for us.
>
>
Re: CHANGES.txt, process improvement solicitation
Posted by Alessandro Benedetti <a....@sease.io>.
Hi Christos, sorry for the confusion, with error prone I literally meant
it's easy to make mistakes when editing the file (writing the entry for the
wrong release, maybe confusion between a new feature or a fix ect.
No reference to google error-prone :)
--------------------------
*Alessandro Benedetti*
Director @ Sease Ltd.
*Apache Lucene/Solr Committer*
*Apache Solr PMC Member*
e-mail: a.benedetti@sease.io
*Sease* - Information Retrieval Applied
Consulting | Training | Open Source
Website: Sease.io <http://sease.io/>
LinkedIn <https://linkedin.com/company/sease-ltd> | Twitter
<https://twitter.com/seaseltd> | Youtube
<https://www.youtube.com/channel/UCDx86ZKLYNpI3gzMercM7BQ> | Github
<https://github.com/seaseltd>
On Fri, 20 Dec 2024 at 09:43, Jan Høydahl <ja...@cominvent.com> wrote:
> Good news, a new release is on its way, including a CLI tool <
> https://github.com/logchange/logchange/pull/31> independent from maven.
> This means we could integrate it into our process with simple commands like
> ./logchange release --version 9.8.0
> ... which will move yml files from folder "unreleased" into folder "v9.8.0"
> and then generate CHANGELOG.md with ./logchange generate.
>
> See https://github.com/logchange/logchange/tree/main/changelog for how the
> strucuture looks like.
>
> Jan
>
> > 19. des. 2024 kl. 20:34 skrev David Smiley <ds...@apache.org>:
> >
> > On Wed, Dec 18, 2024 at 7:30 PM Jan Høydahl <ja...@cominvent.com>
> wrote:
> >
> >> This tool does what is proposed here and looks promising:
> >> https://github.com/logchange/logchange?tab=readme-ov-file
> >>
> >> It requires us to switch to CHANGES.md and it lacks a gradle plugin. But
> >> we could probably contribute some changes to fit our needs..
> >>
> >
> > We don't require a gradle plugin. Arguably it should have been done as
> > simple scripts without being tied to any build system. There's even a
> TODO
> > on its main page that refers to a Docker version. I could imagine one of
> > us essentially doing this (creating the Dockerfile and any scripts) so
> that
> > it can more easily be run; maybe tailored for us.
>
>
Re: CHANGES.txt, process improvement solicitation
Posted by Jan Høydahl <ja...@cominvent.com>.
Good news, a new release is on its way, including a CLI tool <https://github.com/logchange/logchange/pull/31> independent from maven.
This means we could integrate it into our process with simple commands like
./logchange release --version 9.8.0
... which will move yml files from folder "unreleased" into folder "v9.8.0"
and then generate CHANGELOG.md with ./logchange generate.
See https://github.com/logchange/logchange/tree/main/changelog for how the
strucuture looks like.
Jan
> 19. des. 2024 kl. 20:34 skrev David Smiley <ds...@apache.org>:
>
> On Wed, Dec 18, 2024 at 7:30 PM Jan Høydahl <ja...@cominvent.com> wrote:
>
>> This tool does what is proposed here and looks promising:
>> https://github.com/logchange/logchange?tab=readme-ov-file
>>
>> It requires us to switch to CHANGES.md and it lacks a gradle plugin. But
>> we could probably contribute some changes to fit our needs..
>>
>
> We don't require a gradle plugin. Arguably it should have been done as
> simple scripts without being tied to any build system. There's even a TODO
> on its main page that refers to a Docker version. I could imagine one of
> us essentially doing this (creating the Dockerfile and any scripts) so that
> it can more easily be run; maybe tailored for us.
Re: CHANGES.txt, process improvement solicitation
Posted by David Smiley <ds...@apache.org>.
On Wed, Dec 18, 2024 at 7:30 PM Jan Høydahl <ja...@cominvent.com> wrote:
> This tool does what is proposed here and looks promising:
> https://github.com/logchange/logchange?tab=readme-ov-file
>
> It requires us to switch to CHANGES.md and it lacks a gradle plugin. But
> we could probably contribute some changes to fit our needs..
>
We don't require a gradle plugin. Arguably it should have been done as
simple scripts without being tied to any build system. There's even a TODO
on its main page that refers to a Docker version. I could imagine one of
us essentially doing this (creating the Dockerfile and any scripts) so that
it can more easily be run; maybe tailored for us.
Re: CHANGES.txt, process improvement solicitation
Posted by Jan Høydahl <ja...@cominvent.com>.
This tool does what is proposed here and looks promising: https://github.com/logchange/logchange?tab=readme-ov-file
It requires us to switch to CHANGES.md and it lacks a gradle plugin. But we could probably contribute some changes to fit our needs..
Jan Høydahl
> 18. des. 2024 kl. 23:52 skrev Alessandro Benedetti <a....@sease.io>:
>
> Hi guys, thanks to David for pointing me in the right direction.
>
> Noticed that more or less I already expressed the same concerns in the
> past, so I was wondering if anyone has any new idea in these regards.
>
> Some new complaints from my side:
>
> 1) error prone (old complaint)
> 2) prone to conflict (old complaint)
> 3) couple a contribution to a specific release independently of the future
> backporting or not (my current situation, I don't know if a feature is
> going to 9.8, 9.9 or 10.x and I have to wait for that before I merge to
> main)
>
> Following the Keep It Simple Stupid approach, can you remember me what's
> wrong in just using the git log to produce a release note? Sure it won't be
> as nice as the current version maybe, but from dev perspective I see this
> as a huge win.
>
> Ideas?
>
> Cheers
>
>> On Fri, 17 May 2024, 23:32 Chris Hostetter, <ho...@fucit.org>
>> wrote:
>>
>>
>> : The thing about commit messages is they can't easily be cleaned up after
>> : they are pushed... mistakes there are permanent.
>>
>> Exactly.
>>
>> In particular, a feature might be collaboratively developed & committed by
>> Alice & Bob; but then before it's ever released Carl might find a bug with
>> the new feature, which leads to a collaboration with Diane to tweak the
>> API of the feature. ... which is uslaly best described as a *single*
>> CHANGES entry that credits A+B+C+D (regardless of how many commits it
>> takes)
>>
>> And even if we were all flawless humans that only ever made perfect
>> commits -- not every commit is worthy of a mention in CHANGES (just
>> like not every change is worthy of release note).
>>
>> : > > > Managing CHANGES.txt in each PR/change we do is a pain. It's so
>> : > > > merge-conflict prone. I don't mean to call for the removal of
>> : > > > CHANGES.txt (although I've wished for this off-and-on), but want to
>> : > > > solicit inputs on what can be done to make this easier.
>>
>> I don't mean to call for the removal of github, but the PR model is what
>> makes this particularly painful. If you avoid committing CHANGES.txt
>> entries on your feature branches (or in the old days: in patch files
>> attached to jira) there are less conflicts, and you can add the CHANGES
>> entry after you (manually) run "git merge --squash" and before you run
>> "git commit"
>>
>> : > > > I could be mistaken but maybe it was Calvin Cowie that recommended
>> a
>> : > > > scheme something like the following: each change/PR merely adds its
>> : > > > own txt file to a new CHANGES directory instead of adding to
>> : > > > CHANGES.txt. Then it will be aggregated / concatenated to
>> CHANGES.txt
>> : > > > at a release boundary by the RM using a script. The per-change
>> file
>> : > > > then goes away. The category (e.g. New Feature vs Bug Fix) would
>> need
>>
>> That sounds like a proposal I made on the lucene list 10-15 years ago.
>>
>> I still like it in theory.
>>
>> I'm not really a fan of the idea that the snippet files get deleted on
>> release though...
>>
>> IIRC when i suggested this back in the day the focus of the discussion
>> wasn't about simplifying individual commits/backports, allthough it was
>> related. The pain point was some dispute as to wether bug fixes being
>> released in (for example) 4.1.1, 4.0.1, and 3.9.7 should appear in the
>> CHANGES entires for all 3 of those releases, or just 3.9.7 since it was
>> oldest -- even though that might misslead people into thinking it was also
>> "fixed" in 4.0.0 (and 4.1.0) and how to manage that in a way that made
>> sense and didn't involve complicated merges between bug fix branches.
>>
>> My argument was that there should be a ./CHANGES/ directory where we kept
>> small files each listing a single (logical) "Change Entry" and that the
>> release process should (after prepending them all into CHANGES.txt) should
>> *move* them into a subdirectory named after the release, and that sub
>> direcory gets copied back to trunk (aka: main)
>>
>> The idea being that now it's very easy to tell -- both on release branch,
>> and on main -- exactly what versions every change was made in, just by
>> looking at the directory structure
>>
>> Mind you: this was all back in SVN when branches were a much more heavy
>> weight operation then in GIT. I don't know that i feel strongly about the
>> "copy back to main" bit, but I do think it would make more sense to move
>> the snippet files into release specific directories then to just delete
>> them outright.
>>
>> : > > > I'm kind of envious of small projects that can simply rely on
>> GitHub's
>> : > > > release notes generator [1]. Yeah it's just the first-line commit
>> : > > > message, which emphasizes brevity over clarity.
>>
>> Meh. If people want to look at "git log --oneline" they can. CHANGES
>> should contain some value add of human curation.
>>
>>
>>
>> -Hoss
>> http://www.lucidworks.com/
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
>> For additional commands, e-mail: dev-help@solr.apache.org
>>
>>
Re: CHANGES.txt, process improvement solicitation
Posted by Alessandro Benedetti <a....@sease.io>.
Hi guys, thanks to David for pointing me in the right direction.
Noticed that more or less I already expressed the same concerns in the
past, so I was wondering if anyone has any new idea in these regards.
Some new complaints from my side:
1) error prone (old complaint)
2) prone to conflict (old complaint)
3) couple a contribution to a specific release independently of the future
backporting or not (my current situation, I don't know if a feature is
going to 9.8, 9.9 or 10.x and I have to wait for that before I merge to
main)
Following the Keep It Simple Stupid approach, can you remember me what's
wrong in just using the git log to produce a release note? Sure it won't be
as nice as the current version maybe, but from dev perspective I see this
as a huge win.
Ideas?
Cheers
On Fri, 17 May 2024, 23:32 Chris Hostetter, <ho...@fucit.org>
wrote:
>
> : The thing about commit messages is they can't easily be cleaned up after
> : they are pushed... mistakes there are permanent.
>
> Exactly.
>
> In particular, a feature might be collaboratively developed & committed by
> Alice & Bob; but then before it's ever released Carl might find a bug with
> the new feature, which leads to a collaboration with Diane to tweak the
> API of the feature. ... which is uslaly best described as a *single*
> CHANGES entry that credits A+B+C+D (regardless of how many commits it
> takes)
>
> And even if we were all flawless humans that only ever made perfect
> commits -- not every commit is worthy of a mention in CHANGES (just
> like not every change is worthy of release note).
>
> : > > > Managing CHANGES.txt in each PR/change we do is a pain. It's so
> : > > > merge-conflict prone. I don't mean to call for the removal of
> : > > > CHANGES.txt (although I've wished for this off-and-on), but want to
> : > > > solicit inputs on what can be done to make this easier.
>
> I don't mean to call for the removal of github, but the PR model is what
> makes this particularly painful. If you avoid committing CHANGES.txt
> entries on your feature branches (or in the old days: in patch files
> attached to jira) there are less conflicts, and you can add the CHANGES
> entry after you (manually) run "git merge --squash" and before you run
> "git commit"
>
> : > > > I could be mistaken but maybe it was Calvin Cowie that recommended
> a
> : > > > scheme something like the following: each change/PR merely adds its
> : > > > own txt file to a new CHANGES directory instead of adding to
> : > > > CHANGES.txt. Then it will be aggregated / concatenated to
> CHANGES.txt
> : > > > at a release boundary by the RM using a script. The per-change
> file
> : > > > then goes away. The category (e.g. New Feature vs Bug Fix) would
> need
>
> That sounds like a proposal I made on the lucene list 10-15 years ago.
>
> I still like it in theory.
>
> I'm not really a fan of the idea that the snippet files get deleted on
> release though...
>
> IIRC when i suggested this back in the day the focus of the discussion
> wasn't about simplifying individual commits/backports, allthough it was
> related. The pain point was some dispute as to wether bug fixes being
> released in (for example) 4.1.1, 4.0.1, and 3.9.7 should appear in the
> CHANGES entires for all 3 of those releases, or just 3.9.7 since it was
> oldest -- even though that might misslead people into thinking it was also
> "fixed" in 4.0.0 (and 4.1.0) and how to manage that in a way that made
> sense and didn't involve complicated merges between bug fix branches.
>
> My argument was that there should be a ./CHANGES/ directory where we kept
> small files each listing a single (logical) "Change Entry" and that the
> release process should (after prepending them all into CHANGES.txt) should
> *move* them into a subdirectory named after the release, and that sub
> direcory gets copied back to trunk (aka: main)
>
> The idea being that now it's very easy to tell -- both on release branch,
> and on main -- exactly what versions every change was made in, just by
> looking at the directory structure
>
> Mind you: this was all back in SVN when branches were a much more heavy
> weight operation then in GIT. I don't know that i feel strongly about the
> "copy back to main" bit, but I do think it would make more sense to move
> the snippet files into release specific directories then to just delete
> them outright.
>
> : > > > I'm kind of envious of small projects that can simply rely on
> GitHub's
> : > > > release notes generator [1]. Yeah it's just the first-line commit
> : > > > message, which emphasizes brevity over clarity.
>
> Meh. If people want to look at "git log --oneline" they can. CHANGES
> should contain some value add of human curation.
>
>
>
> -Hoss
> http://www.lucidworks.com/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
> For additional commands, e-mail: dev-help@solr.apache.org
>
>
Re: CHANGES.txt, process improvement solicitation
Posted by Chris Hostetter <ho...@fucit.org>.
: The thing about commit messages is they can't easily be cleaned up after
: they are pushed... mistakes there are permanent.
Exactly.
In particular, a feature might be collaboratively developed & committed by
Alice & Bob; but then before it's ever released Carl might find a bug with
the new feature, which leads to a collaboration with Diane to tweak the
API of the feature. ... which is uslaly best described as a *single*
CHANGES entry that credits A+B+C+D (regardless of how many commits it
takes)
And even if we were all flawless humans that only ever made perfect
commits -- not every commit is worthy of a mention in CHANGES (just
like not every change is worthy of release note).
: > > > Managing CHANGES.txt in each PR/change we do is a pain. It's so
: > > > merge-conflict prone. I don't mean to call for the removal of
: > > > CHANGES.txt (although I've wished for this off-and-on), but want to
: > > > solicit inputs on what can be done to make this easier.
I don't mean to call for the removal of github, but the PR model is what
makes this particularly painful. If you avoid committing CHANGES.txt
entries on your feature branches (or in the old days: in patch files
attached to jira) there are less conflicts, and you can add the CHANGES
entry after you (manually) run "git merge --squash" and before you run
"git commit"
: > > > I could be mistaken but maybe it was Calvin Cowie that recommended a
: > > > scheme something like the following: each change/PR merely adds its
: > > > own txt file to a new CHANGES directory instead of adding to
: > > > CHANGES.txt. Then it will be aggregated / concatenated to CHANGES.txt
: > > > at a release boundary by the RM using a script. The per-change file
: > > > then goes away. The category (e.g. New Feature vs Bug Fix) would need
That sounds like a proposal I made on the lucene list 10-15 years ago.
I still like it in theory.
I'm not really a fan of the idea that the snippet files get deleted on
release though...
IIRC when i suggested this back in the day the focus of the discussion
wasn't about simplifying individual commits/backports, allthough it was
related. The pain point was some dispute as to wether bug fixes being
released in (for example) 4.1.1, 4.0.1, and 3.9.7 should appear in the
CHANGES entires for all 3 of those releases, or just 3.9.7 since it was
oldest -- even though that might misslead people into thinking it was also
"fixed" in 4.0.0 (and 4.1.0) and how to manage that in a way that made
sense and didn't involve complicated merges between bug fix branches.
My argument was that there should be a ./CHANGES/ directory where we kept
small files each listing a single (logical) "Change Entry" and that the
release process should (after prepending them all into CHANGES.txt) should
*move* them into a subdirectory named after the release, and that sub
direcory gets copied back to trunk (aka: main)
The idea being that now it's very easy to tell -- both on release branch,
and on main -- exactly what versions every change was made in, just by
looking at the directory structure
Mind you: this was all back in SVN when branches were a much more heavy
weight operation then in GIT. I don't know that i feel strongly about the
"copy back to main" bit, but I do think it would make more sense to move
the snippet files into release specific directories then to just delete
them outright.
: > > > I'm kind of envious of small projects that can simply rely on GitHub's
: > > > release notes generator [1]. Yeah it's just the first-line commit
: > > > message, which emphasizes brevity over clarity.
Meh. If people want to look at "git log --oneline" they can. CHANGES
should contain some value add of human curation.
-Hoss
http://www.lucidworks.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
For additional commands, e-mail: dev-help@solr.apache.org
Re: CHANGES.txt, process improvement solicitation
Posted by Gus Heck <gu...@gmail.com>.
The thing about commit messages is they can't easily be cleaned up after
they are pushed... mistakes there are permanent.
On Fri, May 17, 2024 at 9:47 AM Alessandro Benedetti <a....@sease.io>
wrote:
> I feel the same.
> It's error-prone, easy to forget and even easier to end up with conflicts.
>
> Sure, once there, it's useful and I end up reading it from time to time, to
> quickly refresh on the latest contributions I (or my team) did (but the git
> log is more than enough for that).
>
> In the end, what's in the Changes?
>
> - Type of Contribution ( New Features, Improvements, Optimizations, Bug
> Fixes, Dependency Upgrades, Other Changes)
> - earlier release the change is appearing
> - A headline containing JIRA reference, a short description, Authors
>
> I think all of this information can be in the commit message, author and
> pull request metadata (release version and type of contribution).
> I definitely like the idea of having the release note automatically
> generated from the info above (potentially in a similar manner to the link
> shared by David).
> I admit I've not looked into technical solutions and I am not sure I can
> help pragmatically, but I'll do my best if go this renovation route.
>
> Cheers
>
>
> --------------------------
> *Alessandro Benedetti*
> Director @ Sease Ltd.
> *Apache Lucene/Solr Committer*
> *Apache Solr PMC Member*
>
> e-mail: a.benedetti@sease.io
>
>
> *Sease* - Information Retrieval Applied
> Consulting | Training | Open Source
>
> Website: Sease.io <http://sease.io/>
> LinkedIn <https://linkedin.com/company/sease-ltd> | Twitter
> <https://twitter.com/seaseltd> | Youtube
> <https://www.youtube.com/channel/UCDx86ZKLYNpI3gzMercM7BQ> | Github
> <https://github.com/seaseltd>
>
>
> On Thu, 16 May 2024 at 21:26, Eric Pugh <ep...@opensourceconnections.com>
> wrote:
>
> > I *do* find our current situation the worst of all possible options!
> >
> >
> > > On May 16, 2024, at 2:51 PM, David Smiley <ds...@apache.org> wrote:
> > >
> > > Managing CHANGES.txt in each PR/change we do is a pain. It's so
> > > merge-conflict prone. I don't mean to call for the removal of
> > > CHANGES.txt (although I've wished for this off-and-on), but want to
> > > solicit inputs on what can be done to make this easier.
> > >
> > > I could be mistaken but maybe it was Calvin Cowie that recommended a
> > > scheme something like the following: each change/PR merely adds its
> > > own txt file to a new CHANGES directory instead of adding to
> > > CHANGES.txt. Then it will be aggregated / concatenated to CHANGES.txt
> > > at a release boundary by the RM using a script. The per-change file
> > > then goes away. The category (e.g. New Feature vs Bug Fix) would need
> > > to be encoded somewhere, like maybe in the file name. Even the JIRA
> > > number could be part of the file name and not its content. No ad-hoc
> > > newline use either; just write the message and the script will
> > > line-wrap it. This is probably the simplest and least disruptive
> > > change.
> > >
> > > I'm kind of envious of small projects that can simply rely on GitHub's
> > > release notes generator [1]. Yeah it's just the first-line commit
> > > message, which emphasizes brevity over clarity.
> > >
> > > [1]
> >
> https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
> > >
> > > ~ David Smiley
> > > Apache Lucene/Solr Search Developer
> > > http://www.linkedin.com/in/davidwsmiley
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
> > > For additional commands, e-mail: dev-help@solr.apache.org
> > >
> >
> > _______________________
> > Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 |
> > http://www.opensourceconnections.com <
> > http://www.opensourceconnections.com/> | My Free/Busy <
> > http://tinyurl.com/eric-cal>
> > Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <
> >
> https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw
> >
> >
> > This e-mail and all contents, including attachments, is considered to be
> > Company Confidential unless explicitly stated otherwise, regardless of
> > whether attachments are marked as such.
> >
> >
>
--
http://www.needhamsoftware.com (work)
https://a.co/d/b2sZLD9 (my fantasy fiction book)
Re: CHANGES.txt, process improvement solicitation
Posted by Alessandro Benedetti <a....@sease.io>.
I feel the same.
It's error-prone, easy to forget and even easier to end up with conflicts.
Sure, once there, it's useful and I end up reading it from time to time, to
quickly refresh on the latest contributions I (or my team) did (but the git
log is more than enough for that).
In the end, what's in the Changes?
- Type of Contribution ( New Features, Improvements, Optimizations, Bug
Fixes, Dependency Upgrades, Other Changes)
- earlier release the change is appearing
- A headline containing JIRA reference, a short description, Authors
I think all of this information can be in the commit message, author and
pull request metadata (release version and type of contribution).
I definitely like the idea of having the release note automatically
generated from the info above (potentially in a similar manner to the link
shared by David).
I admit I've not looked into technical solutions and I am not sure I can
help pragmatically, but I'll do my best if go this renovation route.
Cheers
--------------------------
*Alessandro Benedetti*
Director @ Sease Ltd.
*Apache Lucene/Solr Committer*
*Apache Solr PMC Member*
e-mail: a.benedetti@sease.io
*Sease* - Information Retrieval Applied
Consulting | Training | Open Source
Website: Sease.io <http://sease.io/>
LinkedIn <https://linkedin.com/company/sease-ltd> | Twitter
<https://twitter.com/seaseltd> | Youtube
<https://www.youtube.com/channel/UCDx86ZKLYNpI3gzMercM7BQ> | Github
<https://github.com/seaseltd>
On Thu, 16 May 2024 at 21:26, Eric Pugh <ep...@opensourceconnections.com>
wrote:
> I *do* find our current situation the worst of all possible options!
>
>
> > On May 16, 2024, at 2:51 PM, David Smiley <ds...@apache.org> wrote:
> >
> > Managing CHANGES.txt in each PR/change we do is a pain. It's so
> > merge-conflict prone. I don't mean to call for the removal of
> > CHANGES.txt (although I've wished for this off-and-on), but want to
> > solicit inputs on what can be done to make this easier.
> >
> > I could be mistaken but maybe it was Calvin Cowie that recommended a
> > scheme something like the following: each change/PR merely adds its
> > own txt file to a new CHANGES directory instead of adding to
> > CHANGES.txt. Then it will be aggregated / concatenated to CHANGES.txt
> > at a release boundary by the RM using a script. The per-change file
> > then goes away. The category (e.g. New Feature vs Bug Fix) would need
> > to be encoded somewhere, like maybe in the file name. Even the JIRA
> > number could be part of the file name and not its content. No ad-hoc
> > newline use either; just write the message and the script will
> > line-wrap it. This is probably the simplest and least disruptive
> > change.
> >
> > I'm kind of envious of small projects that can simply rely on GitHub's
> > release notes generator [1]. Yeah it's just the first-line commit
> > message, which emphasizes brevity over clarity.
> >
> > [1]
> https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
> >
> > ~ David Smiley
> > Apache Lucene/Solr Search Developer
> > http://www.linkedin.com/in/davidwsmiley
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
> > For additional commands, e-mail: dev-help@solr.apache.org
> >
>
> _______________________
> Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 |
> http://www.opensourceconnections.com <
> http://www.opensourceconnections.com/> | My Free/Busy <
> http://tinyurl.com/eric-cal>
> Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <
> https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
>
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless of
> whether attachments are marked as such.
>
>
Re: CHANGES.txt, process improvement solicitation
Posted by Eric Pugh <ep...@opensourceconnections.com>.
I *do* find our current situation the worst of all possible options!
> On May 16, 2024, at 2:51 PM, David Smiley <ds...@apache.org> wrote:
>
> Managing CHANGES.txt in each PR/change we do is a pain. It's so
> merge-conflict prone. I don't mean to call for the removal of
> CHANGES.txt (although I've wished for this off-and-on), but want to
> solicit inputs on what can be done to make this easier.
>
> I could be mistaken but maybe it was Calvin Cowie that recommended a
> scheme something like the following: each change/PR merely adds its
> own txt file to a new CHANGES directory instead of adding to
> CHANGES.txt. Then it will be aggregated / concatenated to CHANGES.txt
> at a release boundary by the RM using a script. The per-change file
> then goes away. The category (e.g. New Feature vs Bug Fix) would need
> to be encoded somewhere, like maybe in the file name. Even the JIRA
> number could be part of the file name and not its content. No ad-hoc
> newline use either; just write the message and the script will
> line-wrap it. This is probably the simplest and least disruptive
> change.
>
> I'm kind of envious of small projects that can simply rely on GitHub's
> release notes generator [1]. Yeah it's just the first-line commit
> message, which emphasizes brevity over clarity.
>
> [1] https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
>
> ~ David Smiley
> Apache Lucene/Solr Search Developer
> http://www.linkedin.com/in/davidwsmiley
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@solr.apache.org
> For additional commands, e-mail: dev-help@solr.apache.org
>
_______________________
Eric Pugh | Founder | OpenSource Connections, LLC | 434.466.1467 | http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | My Free/Busy <http://tinyurl.com/eric-cal>
Co-Author: Apache Solr Enterprise Search Server, 3rd Ed <https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
This e-mail and all contents, including attachments, is considered to be Company Confidential unless explicitly stated otherwise, regardless of whether attachments are marked as such.