Breaking/nex 681/notes from composers

oat-sa / tao-release-notes

GNU General Public License v2.0

1 stars 0 forks source link

Breaking/nex 681/notes from composers #1

Closed oatymart closed 4 years ago

oatymart commented 4 years ago

https://oat-sa.atlassian.net/browse/NEX-681

Thanks to @ricproenca-tao and @oatymart the release notes extractor CLI tool is being brought officially to oat-sa!

Original code was forked from tao-extension-release and slimmed down
@ricproenca-tao added methods to look up versions and write to .md files
I've added commander as a command interpreter
Added possibility to provide 2 composer.json files as params
Added mode which prompts for 2 composers
Added mode for a single extension notes extraction
taoReleaseNotes binary available after npm link or npm i -g @oat-sa/tao-release-notes (when published)
Unit & integration tests - about 50% of new code covered
Added CSV output option as alternative to Markdown

Testing suggestions:

(install according to README)
taoReleaseNotes composers --c1 tests/fixtures/small-composer.json --c2 tests/fixtures/small-composer2.json -a
taoReleaseNotes composers and provide your own
taoReleaseNotes single -e tao-core

oatymart commented 4 years ago

Bypass asking versions of every extension - When you have lots of extensions this is a little boring.

By the way, there is the CLI argument --autoVersions which prevents this where it can. Do you think that should be true by default? Or enabled in some way for the prompted composers scenario?

ricproenca-tao commented 4 years ago

Bypass asking versions of every extension - When you have lots of extensions this is a little boring.

By the way, there is the CLI argument --autoVersions which prevents this where it can. Do you think that should be true by default? Or enabled in some way for the prompted composers scenario?

Sorry, I missed that.I don't think we should enable by default, at least for now. But later on, after some releases and get more confident about the tool I will enable it for sure.

oatymart commented 4 years ago

Can you please have a look, I have an issue with the generated CSV file, the rows are repeated

The output looks as expected to me; this was the requested format for the CSV output (extension name and version repeated as many times as there are individual notes for that version).

The header row appears numerous times because this is the concatenation of all the individual files. Were you suggesting that I should strip the extra headers out as part of the concatenation?

krampstudio commented 4 years ago

Can you please have a look, I have an issue with the generated CSV file, the rows are repeated

The output looks as expected to me; this was the requested format for the CSV output (extension name and version repeated as many times as there are individual notes for that version).

The header row appears numerous times because this is the concatenation of all the individual files. Were you suggesting that I should strip the extra headers out as part of the concatenation?

Ok, then the format can be reworked if needed then