📰 Custom Issue
Reference: #7166
Reach a contributor agreement on how to proceed with whatsnew updates to the towncrier generated changelog for a point (patch) release.
Currently iris generates a single separate whatsnew for each major or minor release with point (patch) releases included within that major or minor whatsnew page.
The towncrier workflow (see #7116) automatically collates the changelog directory news fragment files and generates the major or minor release whatsnew page.
We now have the problem of injecting the point (patch) release highlights into the associated whatsnew page, along with any relevant changelog news fragments.
Initial options:
- Follow the
towncrier workflow and henceforth (breaking with prior tradition) generate a dedicated point (patch) whatsnew release page i.e., we use towncrier to build the point (patch) changelog from news fragment files.
- Follow existing tradition and incorporate the point (patch) details within the already existing major or minor
whatsnew page. However, this will require manually adding and formatting the fragments directly into the page.
There may be alternative workflows to explore.
In both proposed initial options, the dedicated hightlights.rst associated with the whatsnew page is still manually edited to include the point (patch) hightlights.
📰 Custom Issue
Reference: #7166
Reach a contributor agreement on how to proceed with
whatsnewupdates to thetowncriergenerated changelog for a point (patch) release.Currently
irisgenerates a single separatewhatsnewfor each major or minor release with point (patch) releases included within that major or minorwhatsnewpage.The
towncrierworkflow (see #7116) automatically collates thechangelogdirectory news fragment files and generates the major or minor releasewhatsnewpage.We now have the problem of injecting the point (patch) release highlights into the associated
whatsnewpage, along with any relevant changelog news fragments.Initial options:
towncrierworkflow and henceforth (breaking with prior tradition) generate a dedicated point (patch)whatsnewrelease page i.e., we usetowncrierto build the point (patch) changelog from news fragment files.whatsnewpage. However, this will require manually adding and formatting the fragments directly into the page.There may be alternative workflows to explore.
In both proposed initial options, the dedicated
hightlights.rstassociated with thewhatsnewpage is still manually edited to include the point (patch) hightlights.