diff --git a/README.md b/README.md index fe4c0ea..ac4622f 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Options: Commands: add-changelog Creates a new changelog entry (i.e. releasy add-changelog -i "my-issue-id" -p "feature" -t "audit" -m "My super duper text") add-releasenote Creates a new release note entry (i.e. releasy add-releasenote -i "my-issue-id" -p "feature" -t "audit" -m "My super duper text") - create-releasenotes Creates releasenotes based on changelog entries for a dedicated release (i.e. releasy create-releasenotes -v "1.2.3" -p "some-permalink") + create-releasenotes Creates releasenotes based on release note entries for a dedicated release (i.e. releasy create-releasenotes -v "1.2.3" -p "some-permalink") update-changelog Updates the CHANGELOG.md based on changelog entries for a dedicated release (i.e. releasy update-changelog -v "1.2.3" -p "some-permalink") Run 'releasy [command] -?|-h|--help' for more information about a command. diff --git a/src/releasy/Program.cs b/src/releasy/Program.cs index bc22ac0..701d319 100644 --- a/src/releasy/Program.cs +++ b/src/releasy/Program.cs @@ -91,12 +91,12 @@ app.Command("create-releasenotes", (command) => { - command.Description = "Creates releasenotes based on changelog entries for a dedicated release (i.e. releasy create-releasenotes -v \"1.2.3\" -p \"some-permalink\")"; + command.Description = "Creates releasenotes based on release note entries for a dedicated release (i.e. releasy create-releasenotes -v \"1.2.3\" -p \"some-permalink\")"; var versionOption = command.Option("-v|--version", "Release version", CommandOptionType.SingleValue); var permaLinkOption = command.Option("-p|--permaLink", "Permalink template that points to the VCS issue id", CommandOptionType.SingleValue); var inputDirectoryOption = command.Option("-i|--inputDirectory", "Input directory to scan for release note items (defaults to '.')", CommandOptionType.SingleValue); var outputDirectoryOption = command.Option("-o|--outputDirectory", "Output directory where a release note will be stored (defaults to '.')", CommandOptionType.SingleValue); - var archiveDirectoryOption = command.Option("-a|--archiveDir", "Archive directory (if not set deletes changelogs)", CommandOptionType.SingleValue); + var archiveDirectoryOption = command.Option("-a|--archiveDir", "Archive directory (if not set deletes existing release note entries)", CommandOptionType.SingleValue); command.HelpOption(); command.OnExecute(() => { @@ -105,7 +105,7 @@ : ReadInput("Enter release version"); var permaLink = permaLinkOption.HasValue() ? permaLinkOption.Value() ?? throw new InvalidOperationException(nameof(permaLinkOption.Value)) - : ReadInput("Enter the perma-link template that points to the VCS issue id"); + : ReadInput("Enter the permalink template that points to the VCS issue id"); var inputDirectory = inputDirectoryOption.HasValue() ? inputDirectoryOption.Value() ?? throw new InvalidOperationException(nameof(inputDirectoryOption.Value)) : "."; @@ -146,7 +146,7 @@ : ReadInput("Enter release version"); var permaLink = permaLinkOption.HasValue() ? permaLinkOption.Value() ?? throw new InvalidOperationException(nameof(permaLinkOption.Value)) - : ReadInput("Enter the perma-link template that points to the VCS issue id"); + : ReadInput("Enter the permalink template that points to the VCS issue id"); var inputDirectory = inputDirectoryOption.HasValue() ? inputDirectoryOption.Value() ?? throw new InvalidOperationException(nameof(inputDirectoryOption.Value)) : ".";