On 2020-11-01 20:23:20 +0100 (+0100), Thomas Goirand wrote: [...] > However, if I am to put more efforts on stuff like that, my priority > would be first on getting the reno release notes published in the Debian > package. I've been thinking about this for a long time, and haven't > figured out yet what would be the best way, with a reasonable workflow. > > From the Debian perspective, I'd have to: > - generate the release notes from the last version in Debian Stable, up > to what's in Sid. For example, I would include all the OpenStack release > notes for Stein, Train, Ussuri and Victoria in all packages uploaded for > Debian Bullseye, as this would concern anyone upgrading from Buster. > - make it so that release notes would be generated from Git, and maybe > stored in a debian/release-notes folder, so that it wouldn't generate a > diff with the original upstream tag. > > The drawback would be that, on each upload of a new Debian revision, the > debian.tar.xz will contain the release notes, which could be of > significant size (especially if they include static objects like CSS, > JS, and all what makes a theme). > > If you have any other suggestion concerning how to handle these release > notes, please let me know. It's likely I'm missing some subtle reason for the complexities you outline above, but if you install python3-reno and then run `reno report` in the upstream Git repository for any project with a releasenotes tree (or pass the path to said Git repository in the command line) it will generate a reStructuredText compilation of the release notes contained therein. Very lightweight, no need for extra files or anything. I'd think you could just dump that output into a NEWS file or similar at binary package build time. This is basically the same thing reno's Sphinx extension does under the covers. Check out `reno report --help` for a number of flags you might want to pass it to make the results more readable like omitting the source filename comments, skipping notes earlier than a certain version, collapsing pre-release notes, and so on. A quick test of Nova's release notes indicates that even if you don't truncate them though and include everything back to when the project started using reno 5 years ago, that NEWS file would only increase the compressed size of the nova-doc package by 1%. -- Jeremy Stanley
Attachment:
signature.asc
Description: PGP signature