[
https://issues.apache.org/jira/browse/YETUS-568?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Allen Wittenauer reassigned YETUS-568:
--------------------------------------
Assignee: Allen Wittenauer
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.
> break apart versioning of files and directories
> -----------------------------------------------
>
> Key: YETUS-568
> URL: https://issues.apache.org/jira/browse/YETUS-568
> Project: Yetus
> Issue Type: Improvement
> Components: Release Doc Maker
> Reporter: Allen Wittenauer
> Assignee: Allen Wittenauer
> Priority: Major
>
> Currently, releasedocmaker always generates a version directory wherever it
> is told to write it's output:
> {code}
> 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
> {code}
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
