What I meant by the release notes want to live in source control is that that they are fixed to that point in the software version control repository. They can be updated later as necessary, but if someone needs to check out that version (to find a bug, for particular vendor support, etc.) the notes will be there.
Having the release notes living apart from the software doesn't sound good to me– they could get out of sync. We can have copy the release notes to a web page manually or by a script if we need to. I just wanted to put a draft in the wiki so we could quickly iterate on them, then put them in version control. -adam -adam On Sun, Mar 29, 2020 at 12:49 PM Nathan Hartman <hartman.nat...@gmail.com> wrote: > On Sun, Mar 29, 2020 at 2:43 PM Gregory Nutt <spudan...@gmail.com> wrote: > > > > > > The release notes really want to be in source control, > > > > That is the reason that I always kept the ReleaseNotes in the > > repository. Then there is no possibility that the ReleaseNotes can ever > > become decouple from the release even after years and changes in ISPs. > > > > That is the same reason that I keep all of the Documentation in the > > repository, so that we have versioned documentation for the release. > > > > Lots of advantages to keeping version related stuff inside the release! > > > Okay I agree, but for purposes of being able to correct/update release > notes later, can we write in the release notes that a newer more updated > version of them may be on the website, and provide a link? That way, you'll > always have a release notes in the release, but with the possibility to > make corrections later. > > Cheers, > Nathan > -- Adam Feuer <a...@starcat.io>
