Pre-requisites
- OSX
- Mono
Instructions
- Unzip the archive.
- Open Terminal.
- Run
./relnotes.sh
, which will provide further instructions.
Notes
Issues only appear in the release notes when all of the following criteria are met:
- Must be assigned to the desired Milestone (e.g.
1.2
). - Must not be tagged with
chore
. - If the status is
closed
, it must be tagged with one of the following:bug
,enhancement
, orperformance
. - If the status is
open
, it must be tagged withknown-issue
.
To find closed issues that fall between the cracks (due to not having any of the abovementioned tags), you can search the repo's issues with the Github filter string milestone:NNN is:closed is:issue -label:bug -label:enhancement -label:performance -label:chore
, where NNN
is the milestone name.
To control the header of both the Github release notes, as well as the export XML release notes, you edit the markup in the Github milestone. See Couchbase Lite .NET's 1.2 milestone as an example.
The footers for the XML release notes can be controlled by editing the appropriate {repository_name}-footer.xml
file in the bin/Debug
folder of the unzipped archive. When the tool runs for a given repo, it will append the corresponding footer XML to the generated release notes markup.