Update releasy commands and descriptions

README.md

@@ -18,8 +18,9 @@ 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")
-  create-releasenotes  Creates releasenotes based on changelog entries for a dedicated release (i.e. releasy create-releasenotes -v "1.2.3" -p "some-perma-link")
-  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-perma-link")
+  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") 
+  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.
 ```

samples/46caaa88ddd84c46a68e09ac6c385a74.rne

@@ -0,0 +1,14 @@
+{
+  "Id": "46caaa88-ddd8-4c46-a68e-09ac6c385a74",
+  "IssueId": "1001",
+  "Prefix": "Feature",
+  "Tag": "audit",
+  "Message": "Added audit module",
+  "Instructions": [
+    "first\r\n",
+    "second step\r\n",
+    "third step\r\n"
+  ],
+  "CreatedAt": "2024-02-19T13:10:18.360161+01:00",
+  "CreatedBy": "Thomas Duft"
+}

samples/65cf6edf1b864affb4a10ea140b0c1f9.rne

@@ -0,0 +1,14 @@
+{
+  "Id": "65cf6edf-1b86-4aff-b4a1-0ea140b0c1f9",
+  "IssueId": "1002",
+  "Prefix": "Fix",
+  "Tag": "audit",
+  "Message": "Fixed wrong db schema",
+  "Instructions": [
+    "first run the db migrations\r\n",
+    "seed data\r\n",
+    "test your application\r\n"
+  ],
+  "CreatedAt": "2024-02-19T13:11:12.3772984+01:00",
+  "CreatedBy": "Thomas Duft"
+}

src/releasy/Program.cs

@@ -91,7 +91,7 @@
 
 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-perma-link\")";
+  command.Description = "Creates releasenotes based on changelog 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);
@@ -133,7 +133,7 @@
 app.Command("update-changelog", (command) =>
 {
   // see keepachangelog.com (https://keepachangelog.com/en/1.0.0/#how)
-  command.Description = "Updates the CHANGELOG.md based on changelog entries for a dedicated release (i.e. releasy update-changelog -v \"1.2.3\" -p \"some-perma-link\")";
+  command.Description = "Updates the CHANGELOG.md based on changelog entries for a dedicated release (i.e. releasy update-changelog -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);

src/releasy/Templates/ReleaseNotes.liquid

@@ -3,5 +3,6 @@
 ## {{ prefix.Name }}
 {% for entry in prefix.Entries %}
 - {% if entry.IssueId != "" %}[#{{ entry.IssueId }}]({{ PermaLink}}{{ entry.IssueId }}): {% endif %}{{ entry.Message }}{% if entry.Tag != "" %} ({{ entry.Tag }}){% endif %}
-{%- endfor %}
+{% for instruction in entry.Instructions %}  - {{ instruction }}{%- endfor -%}
+{%- endfor -%}
 {% endfor -%}