See https://logchange.dev/tools/logchange/reference/#yaml-entry-format for reference.
The 'issues' key is valid, it will render in the CHANGELOG.md as a #123 link, which will make sense when rendered on Github UI. For most of the changelog entries we tend to use 'links', even for links to PRs. But both are valid. Could be that we should recommend one or the other. Benefit of "links" is that it renders as an actual web link in Markdown, that you can follow even if the CHANGES.md is rendered elsewhere. Benefit of 'issues' is that it is quick and easy.. I see there is a changelog yml placed in a sub folder of unreleased/. That is not supported. Other YML with syntax error may need to be fixed too... Jan > 22. des. 2025 kl. 21:29 skrev Anshum Gupta <[email protected]>: > > Going through the doc link ( > https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc) again, it > seems like 'issues/issue' isn't a valid tag. > > On Mon, Dec 22, 2025 at 3:11 PM Anshum Gupta <[email protected]> wrote: > >> While working on the release, I was going through the changelog in the >> unreleased folder. >> I see both 'issues' as well as 'links' with JIRA number and url. I assumed >> issues was meant to integrate with Github issues but I'm not sure if that's >> true. >> >> Can Jan or someone who has a better idea confirm what this should be as >> we'll need to standardize. >> >> Also, I am running into build failure because of bad tags in the changelog >> entry for issues. Getting confirmation on this will help me fix the build >> issue. >> >> On Thu, Nov 20, 2025 at 9:13 AM David Smiley <[email protected]> wrote: >> >>> Nice! >>> >>> On Thu, Nov 20, 2025 at 3:15 AM Jan Høydahl <[email protected]> >>> wrote: >>> >>>> Hi, >>>> >>>> I have made a new Github Workflow that generates logchange yml files for >>>> each SolrBot dependency PR. >>>> That means that the changelog travels with the commit, including >>> backports >>>> etc, relieving the release manager >>>> for additional work with adding those in bulk during a release. >>>> >>>> Note that there are still >100 open RenovateBot PRs that still don't >>> have >>>> the changelog added. So if you're >>>> about to merge a dependency PR, please first order a rebase or do a >>> commit >>>> on the PR, which will then >>>> trigger the GH workflow and add the changelog commit to the PR branch. >>>> >>>> @Anshum, this means that for the 10.0 release, where you already bulk >>>> added changelog entries, hopefully >>>> all dependency upgrades landing on branch_10_0 will include a changelog. >>>> You should still look out for commits >>>> falling through the cracks. >>>> >>>> Jan >>>> >>>>> 30. okt. 2025 kl. 09:09 skrev Jan Høydahl <[email protected]>: >>>>> >>>>> Hi, >>>>> >>>>> The transition to logchange/ folder is now done, and solr/CHANGES.txt >>> is >>>> gone. >>>>> In repository root there is a new CHANGELOG.md file which is generated >>>> (Do not edit!) >>>>> >>>>> Jan >>>>> >>>>>> 29. okt. 2025 kl. 08:26 skrev Jan Høydahl <[email protected]>: >>>>>> >>>>>> Hi, >>>>>> >>>>>> I'm almost done with the transition, but it's taking some time to >>>> consolidate branches etc. >>>>>> Even if CHANGES.txt is not yet gone, please contune adding your >>>> changelogs to the >>>>>> changelog/unreleased folder. >>>>>> >>>>>> Jan >>>>>> >>>>>>> 22. okt. 2025 kl. 20:50 skrev Jan Høydahl <[email protected]>: >>>>>>> >>>>>>> Hi everyone, >>>>>>> >>>>>>> We're transitioning to logchange, an automated changelog generation >>>> tool. >>>>>>> Starting today, there's a six days transition period where you can >>> add >>>> changelog >>>>>>> entries using either the old CHANGES.txt method or the new logchange >>>> workflow. >>>>>>> On Tuesday, October 28th, CHANGES.txt will be removed and the new >>>> workflow will >>>>>>> be mandatory across main, branch_10x, branch_10_0, and branch_9x. >>>>>>> >>>>>>> Why? The new workflow is more maintainable and reduces merge >>> conflicts >>>> during >>>>>>> active development. >>>>>>> >>>>>>> What does this mean for you? Instead of editing CHANGES.txt, you'll >>>> create a small >>>>>>> YAML file in the changelog/unreleased/ directory. The build system >>>> will automatically >>>>>>> compile these into /CHANGELOG.md during release. For dev-docs on the >>>> new process, see: >>>>>>> >>>>>>> https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc >>>>>>> >>>>>>> Questions? Feel free to reply to this thread or ask on Slack. >>>>>>> >>>>>>> Thanks, >>>>>>> David and Jan >>>>>> >>>>> >>>> >>>> >>>> --------------------------------------------------------------------- >>>> To unsubscribe, e-mail: [email protected] >>>> For additional commands, e-mail: [email protected] >>>> >>>> >>> >> >> >> -- >> Anshum Gupta >> > > > -- > Anshum Gupta
