[YETUS-568] break apart versioning of files and directories

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.7.0
• Component/s: Release Doc Maker

Release Note

<!-- markdown -->

`releasedocmaker` no longer automatically creates files or directories that represent the version being built. In addition, the names of the CHANGES file has been renamed to CHANGELOG.

Versioned files may be requested via the `--fileversions` option. Versioned directories may be requested via the `dirversions` option. Either option or both are required when releasedocmaker is used with multiple versions or ranges.

• Flags: Important
• Assignee: Allen Wittenauer
• Reporter: Allen Wittenauer
• Created: 26/Oct/17 18:19
• Updated: 30/Nov/17 03:52
• Resolved: 29/Nov/17 17:27

Description

Currently, releasedocmaker always generates a version directory wherever it is told to write it's output:

rdm -p yetus -v 0.6.0   ->   0.6.0/CHANGES.0.6.0.md
                                           0.6.0/RELEASENOTES.0.6.0.md

rdm -o foo -p yetus -v 0.6.0   ->   foo/0.6.0/CHANGES.0.6.0.md
                                                     foo/0.6.0/RELEASENOTES.0.6.0.md

In some situations, this is really less than ideal, especially given that the files also have the version stuck in them. (In fact, the current rdm output is making life difficult for Yetus' own release process.)

We need to rethink this a bit. Some ideas for improvement:

• Add a flag (--fileversions?) that add the version to the filenames, e.g., CHANGES.MD to CHANGES.0.6.0.md
• Add a flag (--dirversions?) that creates the version directory. e..g., -O foo --dirversions would write in foo/0.6.0 as it does today.

While we are breaking rdm, it may be worthwhile to change from CHANGES to CHANGELOG, which will make a lot of other software that looks specifically for CHANGELOG files happy.

Issue Links

• blocks: YETUS-15 build environment