Skip to content

Only list changes to a subpackage in its release notes - #612

Open
maleadt wants to merge 2 commits into
JuliaRegistries:masterfrom
maleadt:tb/subdir-changelog
Open

maleadt wants to merge 2 commits into
JuliaRegistries:masterfrom
maleadt:tb/subdir-changelog

Conversation

@maleadt

@maleadt maleadt commented Nov 17, 2026

Copy link
Copy Markdown

A subpackage's release notes list every pull request merged and every issue closed in the repository since its previous release. In a monorepo they mostly describe other packages. For example, OrdinaryDiffEqPDIRK-v2.5.4 lists Extrapolation and DAE initialization changes, and KernelInterface-v0.4.6 repeats the notes of KernelAbstractions v0.10.6.

For subpackages:

  • Default format: only pull requests that changed a file in the subpackage's directory are listed (moving a file out of it counts). Issues are left out, since nothing ties them to a subpackage. Checking a pull request takes one paginated request for its file list, which stops at the first match and is cached. A pull request too large for GitHub to list in full (more than 3000 files) is kept.
  • conventional format: the log only covers the subpackage's directory. It also now starts from the package's own previous version tag, not from the newest release in the repository, which could belong to another package or a higher version. That second change fixes backports of top-level packages too.
  • github format: unchanged, because GitHub's release-notes API has no path filter.

A subpackage's release notes listed every pull request merged and every
issue closed in the repository since its previous release, so in a
monorepo they mostly described other packages.

Keep only the pull requests that changed files in the subpackage's
directory, and leave out issues, which can't be attributed to a
subpackage.
The conventional changelog started from the newest GitHub release in the
repository, whatever package or version it belonged to, and listed every
commit since then. For a subpackage, that is usually another package's
release; for a backport, a higher version.

Start from the package's highest earlier version tag instead, using the
lookup the default changelog already uses, and for a subpackage only
list commits that changed its directory. Tags created earlier in the same
run are added to the tag cache, so that a backfilled release starts from
the one created just before it.
@maleadt
maleadt force-pushed the tb/subdir-changelog branch from eccc3de to 4317f86 Compare November 17, 2026 10:32

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant