Skip to content

Commit a293d67

Browse files
committed
chore(zarr-metadata): note the sdist allowlist, and let misc entries speak
zarr-developers#4248 gave this package's sdist an explicit allowlist and merged without a news fragment, so a user-visible packaging change was about to miss the 0.5.0 notes. Add one. Filing it as `misc` exposed that towncrier's built-in `misc` type sets `showcontent = false`: the entry would render as a bare PR link, which tells a reader nothing. Restate all five types the `changes/README.md` menu offers — declaring any type replaces the built-in set — as the defaults verbatim except for `misc`, which now shows its content. A change worth a release note is worth a sentence, whatever its category. Assisted-by: ClaudeCode:claude-opus-5
1 parent b1d4132 commit a293d67

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
The source distribution now ships an explicit allowlist (`/src`, `/tests`,
2+
`/docs`, `/mkdocs.yml`, `/justfile`, `/CHANGELOG.md`) rather than whatever
3+
happens to sit in the package directory, so an sdist both tests and documents
4+
itself and cannot pick up scratch files from the tree it was built in.

‎packages/zarr-metadata/pyproject.toml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,33 @@ underlines = ["", "", ""]
137137
title_format = "## {version} ({project_date})"
138138
issue_format = "[#{issue}](https://github.com/zarr-developers/zarr-python/pull/{issue})"
139139
start_string = "<!-- towncrier release notes start -->\n"
140+
141+
# Declaring any type replaces towncrier's built-in set, so all five the
142+
# `changes/README.md` menu offers are restated here. They are the defaults
143+
# verbatim except for `misc`, whose `showcontent` towncrier defaults to false:
144+
# a `misc` entry would render as a bare PR link, which tells a reader nothing.
145+
# A change worth a release note is worth a sentence, whatever its category.
146+
[[tool.towncrier.type]]
147+
directory = "feature"
148+
name = "Features"
149+
showcontent = true
150+
151+
[[tool.towncrier.type]]
152+
directory = "bugfix"
153+
name = "Bugfixes"
154+
showcontent = true
155+
156+
[[tool.towncrier.type]]
157+
directory = "doc"
158+
name = "Improved Documentation"
159+
showcontent = true
160+
161+
[[tool.towncrier.type]]
162+
directory = "removal"
163+
name = "Deprecations and Removals"
164+
showcontent = true
165+
166+
[[tool.towncrier.type]]
167+
directory = "misc"
168+
name = "Misc"
169+
showcontent = true

0 commit comments

Comments
 (0)