Skip to content

Commit

Permalink
Update releasy command descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasduft committed Feb 19, 2024
1 parent 50fd125 commit 9df2d1c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions src/releasy/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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(() =>
{
Expand All @@ -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))
: ".";
Expand Down Expand Up @@ -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))
: ".";
Expand Down

0 comments on commit 9df2d1c

Please sign in to comment.